ASFF の属性 - AWS Security Hub

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

ASFF の属性

以下のリストに、AWS Security Finding 形式 (ASFF) の属性およびオブジェクトを示します。オブジェクトの属性と構造の詳細を表示するには、オブジェクト名を選択してください。

必須の属性

すべての結果には、次の属性が必要です。

AwsAccountId

必須

結果条件が適用される AWS アカウント ID。

タイプ: 文字列

最大長:12桁

"AwsAccountId": "111111111111"
CreatedAt

必須

結果によってキャプチャされた潜在的なセキュリティ上の問題がいつ作成されたかを示します。

-CreatedAtタイムスタンプは、検索レコードが作成された時刻を反映します。したがって、それはFirstObservedAtタイムスタンプを入力します。イベントまたは脆弱性が最初に検出された時刻を反映します。

このタイムスタンプは、検出結果の最初の生成時に提供する必要があり、検出結果に対するそれ以降の更新時に変更することはできません。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"CreatedAt": "2017-03-22T13:22:13.933Z"
注記

検出結果は、最新の更新から 90 日後、または更新が行われない場合は作成日から 90 日後に削除されます。検出結果を 90 日間以上保存するには、検出結果を S3 バケットにルーティングする Amazon EventBridge でルールを設定できます。

Description

必須

検出結果の説明。このフィールドに指定できるのは、固有ではない共通のテキストまたは検出結果のこのインスタンスに固有の詳細です。

タイプ: 文字列

最大長: 1,024

"Description": "The version of openssl found on instance i-abcd1234 is known to contain a vulnerability."
GeneratorId

必須

検出結果を生成したソリューション固有のコンポーネント (個別のロジックの単位) の識別子。セキュリティ検出製品からのさまざまなソリューションでは、このジェネレーターをルール、チェック、ディテクター、プラグインなどと呼ぶことができます。

タイプ: 文字列または ARN

最大長: 512

"GeneratorId": "acme-vuln-9ab348"
Id

必須

検出結果の製品固有の識別子。

タイプ: 文字列または ARN

最大長: 512

検出結果 ID は、以下の制約を満たす必要があります。

  • ID は製品内でグローバルに一意である必要があります。一意性を強制するために、パブリック AWS リージョン名とアカウント ID を識別子に組み込むことができます。

  • 以前の検出結果がすでに存在していないかどうかにかかわらず、識別子をリサイクルすることはできません

  • この ID には、セクションで定義されている、予約されていない文字セットの文字のみを含める必要があります。RFC-3986 Uniform Resource Identifier (URI): 汎用構文

  • AWS 以外のサービスの場合、IDできませんは、リテラル文字列」arn:「。

  • AWS サービスの場合、ID必須検出結果の ARN (使用可能な場合) です。それ以外の場合は、他の一意の識別子を使用できます。

これらの制約は、検出製品内に保持されることが期待されますが、複数の検出製品に保持される必要はありません。

"Id": "us-west-2/111111111111/98aebb2207407c87f51e89943f12b1ef"
ProductArn

必須

Security Hub に登録された後でサードパーティーの検出製品を一意に識別する Security Hub によって生成された ARN。

タイプ: ARN

このフィールドの形式は arn:partition:securityhub:region:account-id:product/company-id/product-id です。

  • Security Hub と統合された AWS サービスの場合、company-idは」aws「、product-idは AWS パブリックサービス名である必要があります。AWS 製品とサービスはアカウントに関連付けられていないため、account-idセクションが空ARN。Security Hub と統合されていない AWS サービスは、サードパーティー製品と見なされます。

  • パブリック製品の場合、company-id および product-id は登録時に指定された ID 値である必要があります。

  • プライベート製品の場合、company-id はアカウント ID である必要があります。product-id は、予約語の "default"、または登録時に指定された ID である必要があります。

例:

// Private ARN "ProductArn": "arn:aws:securityhub:us-east-1:111111111111:product/111111111111/default" // Public ARN "ProductArn": "arn:aws:securityhub:us-west-2::product/aws/guardduty" "ProductArn": "arn:aws:securityhub:us-west-2:222222222222:product/generico/secure-pro"
Resources

必須

検出結果が参照するリソースを記述する、一連のリソースデータタイプ。

タイプ: リソースオブジェクトの配列

オブジェクトの最大数: 32

"Resources": [ { "Type": "AwsEc2Instance", "Id": "i-cafebabe", "Partition": "aws", "Region": "us-west-2", "Tags": { "billingCode": "Lotus-1-2-3", "needsPatching": "true" }, "Details": { "AwsEc2Instance": { "Type": "i3.xlarge", "ImageId": "ami-abcd1234", "IpV4Addresses": [ "54.194.252.215", "192.168.1.88" ], "IpV6Addresses": [ "2001:db8:1234:1a2b::123" ], "KeyName": "my_keypair", "IamInstanceProfileArn": "arn:aws:iam::111111111111:instance-profile/AdminRole", "VpcId": "vpc-11112222", "SubnetId": "subnet-56f5f633", "LaunchedAt": "2018-05-08T16:46:19.000Z" } } } ]
SchemaVersion

必須

検出結果が形式設定されているスキーマのバージョン。このフィールドの値は、AWS によって識別された正式公開バージョンの 1 つである必要があります。

現在のリリースでは、AWS Security Finding 形式スキーマのバージョンは2018-10-08

タイプ: 文字列

最大長: 10

形式: YYYY-MM-DD

"SchemaVersion": "2018-10-08"
Severity

必須

検出結果の重要度。

この結果には、LabelまたはNormalized移入。Labelは推奨される属性です。Normalizedはもはや関連性がありません。Security Hub は、Normalized属性を使用しますが、それ以外の場合は使用しません。どちらの属性も含まれていない場合、検出結果は無効です。

Severityによってのみ更新する必要がありますBatchUpdateFindings

重大度情報を提供するには、プロバイダー検索でSeverityオブジェクトのあるFindingProviderFields。「を使用する FindingProviderFields」を参照してください。

タイプ: オブジェクト

"Severity": { "Label": "CRITICAL", "Original": "8.3" }
Title

必須

検出結果のタイトル。このフィールドに指定できるのは、固有ではない共通のテキストまたは検出結果のこのインスタンスに固有の詳細です。

タイプ: 文字列

最大長: 256

Types

必須

検出結果を分類する、namespace/category/classifier の形式の 1 つ以上の検出結果タイプ。

Typesを使用してのみ更新する必要があります。BatchUpdateFindings

の値を提供したいプロバイダの検索Typesを使用するにはTypesFindingProviderFields。「を使用する FindingProviderFields」を参照してください。

タイプ: 文字列の配列

文字列の最大数: 50

  • namespaceは、定義済みの名前空間値のセットに含まれる値である必要があります。

    有効な値: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications

  • categoryはどのような値でもかまいません。しかし、製品を検索するには、結果タイプの分類法のカテゴリを使用することをおすすめします。ASFF のタイプ分類

  • classifierはどのような値でも構いませんが、可能であれば、公開された標準で定義されている識別子を正確に検出結果プロバイダーで使用することをお勧めします。

名前空間はすべての検出結果タイプに必須ですが、カテゴリと分類子はオプションです。分類子を指定した場合は、カテゴリも指定する必要があります。

'/'文字は予約されているため、カテゴリや分類子に使用しないでください。'/' 文字のエスケープはサポートされていません。

"Types": [ "Software and Configuration Checks/Vulnerabilities/CVE" ]
UpdatedAt

必須

検索プロバイダが検索レコードを最後に更新した日時を示します。

このタイムスタンプは、検索レコードが最後に更新された時刻または最後に更新された時刻を表します。したがって、それはLastObservedAtタイムスタンプ。イベントまたは脆弱性が最後に検出された時刻を反映します。

検出結果レコードを更新する際には、このタイムスタンプを現在のタイムスタンプに更新する必要があります。検出結果レコードの作成時には、CreatedAtおよびUpdatedAtタイムスタンプは同じでなければなりません。検出結果レコードを更新した後、このフィールドの値は、それに含まれていたすべての以前の値より大きい値である必要があります。

UpdatedAtBatchUpdateFindings からの変更によって更新されないことに注意してください。これは、BatchImportFindings によってのみ更新されます。

検出結果は、最新の更新から 90 日後、または更新が行われない場合は作成日から 90 日後に削除されます。検出結果を 90 日間以上保存するには、検出結果を Amazon S3 バケットにルーティングする CloudWatch Events でルールを設定できます。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

その他の最上位属性

Action

オプション

リソースに影響する、またはリソースに対して実行されたアクションに関する詳細を提供します。

タイプ: オブジェクト

Compliance

オプション

コントロールに関連する検出結果の詳細。コントロールから生成された検出結果に対してのみ返されます。

タイプ: オブジェクト

"Compliance": { "RelatedRequirements": ["Req1", "Req2"], "Status": "PASSED", "StatusReasons": [ { "ReasonCode": "CLOUDWATCH_ALARMS_NOT_PRESENT"; "Description": "CloudWatch alarms do not exist in the account" } ] }
Confidence

オプション

検出結果の信頼度。信頼度は、検出結果が、識別することが意図されていた動作や問題を正確に識別する可能性として定義されます。

Confidenceを使用してのみ更新する必要があります。BatchUpdateFindings

の値を提供したいプロバイダの検索Confidenceを使用するにはConfidenceFindingProviderFields。「を使用する FindingProviderFields」を参照してください。

タイプ: 整数

最小値はです。 0

値の最大長 100

信頼度は、比率スケールを使用して 0 ~ 100 ベースでスコア付けされます。0 は 0% の信頼度、100 は 100% の信頼度を表します。

ただし、ネットワークトラフィックの統計的偏差に基づくデータの不正引き出しは、実際の不正引き出しが確認されていないため、信頼性がはるかに低くなります。

"Confidence": 42
Criticality

オプション

検出結果に関連付けられているリソースに割り当てられている重要度。スコア 0 は、基になるリソースに重要性がなく、スコア 100 は最も重要なリソース用に予約されています。

Criticalityによってのみ更新する必要がありますBatchUpdateFindings。それはによって更新されるべきではありませんBatchImportFindings

の値を提供したいプロバイダの検索Criticalityを使用するにはCriticalityFindingProviderFields。「を使用する FindingProviderFields」を参照してください。

タイプ: 整数

最小値はです。 0

値の最大長 100

重要度は 0 ~ 100 ベースでスコア付けされ、完全な整数のみをサポートする比率スケールが使用されます。スコア 0 は、基になるリソースに重要性がなく、スコア 100 は最も重要なリソース用に予約されています。

大まかに言うと、重要度を評価するときは、次の点を考慮する必要があります。

  • 他のリソースよりも重要なリソースに影響を及ぼす調査結果はどれですか。

  • これらのリソースは、他のリソースに比べてどれほど重要ですか?

リソースごとに、以下の点を考慮してください。

  • 影響を受けたリソースに機密データ (PII を含む S3 バケットなど) が含まれているか?

  • 影響を受けたリソースにより、攻撃者はアクセスレベルを深めたり、機能を拡張して悪意のあるアクティビティ (sysadmin アカウントへの侵入など) を追加で実行したりすることができるか?

  • そのリソースはビジネスクリティカルなアセット (たとえば、不正なアクセスを受けた場合、収益に大きな影響を与える可能性がある主要なビジネスシステム) であるか?

以下のガイドラインを使用できます。

  • ミッション・クリティカルなシステムを稼働させるリソースや、機密性の高いデータを含むリソースは、75~100の範囲で採点できます。

  • 重要な(ただし、重要なシステムではない)リソースや適度に重要なデータを含むリソースは、25~75の範囲で採点できます。

  • 重要でないシステムを稼働させるリソースや、機密性のないデータを含むリソースは、0~24の範囲で採点する必要があります。

"Criticality": 99
FindingProviderFields

オプション

EclipseBatchImportFindings要求、検索プロバイダが使用するFindingProviderFieldsによってのみ更新されるべき属性の値を提供するためにBatchUpdateFindingsFindingProviderFieldsには、次の属性が含まれています。

  • Confidence

  • Criticality

  • RelatedFindings

  • Severity

  • Types

FindingProviderFieldsによってのみ更新できますBatchImportFindings。これはによって更新できませんBatchUpdateFindings

Security Hub による更新の処理方法の詳細については、BatchImportFindingsFindingProviderFieldsおよび対応するトップレベルの属性については、を使用する FindingProviderFields

タイプ: オブジェクト

"FindingProviderFields": { "Confidence": 42, "Criticality": 99, "RelatedFindings":[ { "ProductArn": "arn:aws:securityhub:us-west-2::product/aws/guardduty", "Id": "123e4567-e89b-12d3-a456-426655440000" } ], "Severity": { "Label": "MEDIUM", "Original": "MEDIUM" }, "Types": [ "Software and Configuration Checks/Vulnerabilities/CVE" ] }
FirstObservedAt

オプション

調査結果によって捕捉された潜在的なセキュリティ問題が最初に観察された時期を示します。

このタイムスタンプは、イベントまたは脆弱性が最初に検出された時刻を反映します。したがって、それはCreatedAtタイムスタンプです。これは、この結果レコードが作成された時間を反映します。

このタイムスタンプは、検出結果レコードが次に更新されるまで不変である必要がありますが、より正確なタイムスタンプがあると判別された場合は更新できます。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"FirstObservedAt": "2017-03-22T13:22:13.933Z"
LastObservedAt

オプション

検出結果でキャプチャされた潜在的なセキュリティ上の問題がセキュリティ検出製品によって最近検出された日時を示します。

このタイムスタンプは、イベントまたは脆弱性が最後に検出された時刻を反映します。したがって、それはUpdatedAtタイムスタンプです。これは、この検索レコードが最後に更新された日時または最後に更新された日時を反映します。

このタイムスタンプを提供することはできますが、最初の検出時には必要ありません。このような場合にフィールドを指定する場合は、タイムスタンプが FirstObservedAt タイムスタンプと同じである必要があります。検出結果が検出されるたびに、最後に検出されたタイムスタンプを反映するようにこのフィールドを更新する必要があります。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"LastObservedAt": "2017-03-23T13:22:13.933Z"
Malware

オプション

検出結果に関連するマルウェアのリスト。

タイプ: マルウェアオブジェクトの配列

オブジェクトの最大数: 5

"Malware": [ { "Name": "Stringler", "Type": "COIN_MINER", "Path": "/usr/sbin/stringler", "State": "OBSERVED" } ]
Network (廃止)

オプション

検出結果に関するネットワーク関連情報の詳細。

このオブジェクトは廃止されました。このデータを提供するには、データをResourcesを使用するかActionオブジェクト。

タイプ: オブジェクト

"Network": { "Direction": "IN", "OpenPortRange": { "Begin": 443, "End": 443 }, "Protocol": "TCP", "SourceIpV4": "1.2.3.4", "SourceIpV6": "FE80:CD00:0000:0CDE:1257:0000:211E:729C", "SourcePort": "42", "SourceDomain": "example1.com", "SourceMac": "00:0d:83:b1:c0:8e", "DestinationIpV4": "2.3.4.5", "DestinationIpV6": "FE80:CD00:0000:0CDE:1257:0000:211E:729C", "DestinationPort": "80", "DestinationDomain": "example2.com" }
NetworkPath

オプション

調査結果に関連するネットワークパス。

の各エントリNetworkPathはパスのコンポーネントを表します。

タイプ: オブジェクトの配列

Note

オプション

検出結果に追加されるユーザー定義のメモ。

結果プロバイダーは、結果の最初のメモを提供できますが、それ以降にメモを追加することはできません。

注意は、BatchUpdateFindings を使用してのみ更新できます。

タイプ: オブジェクト

"Note": { "Text": "Don't forget to check under the mat.", "UpdatedBy": "jsmith", "UpdatedAt": "2018-08-31T00:15:09Z" }
PatchSummary

オプション

パッチ準拠のサマリーを提供します。

タイプ: オブジェクト

Process

オプション

検出結果に関するプロセス関連情報の詳細。

タイプ: オブジェクト

例:

"Process": { "Name": "syslogd", "Path": "/usr/sbin/syslogd", "Pid": 12345, "ParentPid": 56789, "LaunchedAt": "2018-09-27T22:37:31Z", "TerminatedAt": "2018-09-27T23:37:31Z" }
ProductFields

オプション

定義済みの AWS Security Finding 形式の一部ではないソリューション固有の詳細をセキュリティ検出製品に追加で含めることができるデータ型。

Security Hub コントロールによって生成された結果については、ProductFieldsには、コントロールに関する情報が含まれています。「ASFF のコントロール関連情報」を参照してください。

タイプ: キーと値のペアのマップ

ペアの最大数: 50

このフィールドには冗長データを含めないでください。また、AWS Security Finding 形式フィールドと競合するデータを含めることはできません。

ザ・」aws/プレフィックスは、AWS 製品およびサービス専用の予約された名前空間を表します。このプレフィックスを、パートナー製品からの検出結果とともに送信しないでください。

必須ではありませんが、製品はフィールド名を company-id/product-id/field-name として形式設定することが推奨されます。ここで、company-idproduct-id は、検出結果の ProductArn に指定されているものと一致します。

フィールド名には、次の文字を含めることができます: A ~ z、a ~ z、0 ~ 9、0 ~ 9、0 ~ 9、および.: +\ = @ _/-(ハイフン)。

"ProductFields": { "generico/secure-pro/Count": "6", "generico/secure-pro/Action.Type", "AWS_API_CALL", "API", "DeleteTrail", "Service_Name": "cloudtrail.amazonaws.com", "aws/inspector/AssessmentTemplateName": "My daily CVE assessment", "aws/inspector/AssessmentTargetName": "My prod env", "aws/inspector/RulesPackageName": "Common Vulnerabilities and Exposures" }
RecordState

オプション

検出結果の記録状態。

デフォルトでは、サービスによって最初に生成されたときの検出結果は ACTIVE と見なされます。

ARCHIVED 状態は、検出結果がビューで非表示になることを示します。アーカイブされた結果はすぐに削除されません。検索、レビュー、レポートすることができます。

検索プロバイダは、レコードの状態を更新できます。Security Hub は、関連付けられたリソースが削除された場合、リソースが存在しない場合、またはコントロールが無効になっている場合、コントロールベースの検出結果も自動的にアーカイブされます。

レコードの状態がARCHIVEDACTIVEに設定され、結果のワークフローステータスはNOTIFIEDまたはRESOLVEDに設定されている場合、Security Hub はワークフローの状態を自動的にNEW

タイプ: 列挙型

有効な値: ACTIVE | ARCHIVED

"RecordState": "ACTIVE"
RelatedFindings

オプション

関連する検出結果のリスト。

RelatedFindingsを使用してのみ更新する必要があります。BatchUpdateFindings。これは、を使用してのみ更新できません。BatchImportFindings

関連する調査結果のリストを提供するには、検索プロバイダーはRelatedFindingsオブジェクトのあるFindingProviderFields。「を使用する FindingProviderFields」を参照してください。

タイプ: の配列RelatedFindingobjects

オブジェクトの最大数: 10

"RelatedFindings": [ { "ProductArn": "arn:aws:securityhub:us-west-2::product/aws/guardduty", "Id": "123e4567-e89b-12d3-a456-426655440000" }, { "ProductArn": "arn:aws:securityhub:us-west-2::product/aws/guardduty", "Id": "AcmeNerfHerder-111111111111-x189dx7824" } ]
Remediation

オプション

検出結果の修復オプション。

タイプ: オブジェクト

"Remediation": { "Recommendation": { "Text": "Run sudo yum update and cross your fingers and toes.", "Url": "http://myfp.com/recommendations/dangerous_things_and_how_to_fix_them.html" } }
SourceUrl

オプション

検出製品内の現在の検出結果に関するページにリンクする URL。

タイプ: URL

ThreatIntelIndicators

オプション

検出結果に関連する脅威インテリジェンスの詳細。

タイプ: 脅威インテリジェンスインジケータオブジェクトの配列

オブジェクトの最大数: 5

"ThreatIntelIndicators": [ { "Type": "IPV4_ADDRESS", "Value": "8.8.8.8", "Category": "BACKDOOR", "LastObservedAt": "2018-09-27T23:37:31Z", "Source": "Threat Intel Weekly", "SourceUrl": "http://threatintelweekly.org/backdoors/8888" } ]
UserDefinedFields

オプション

検出結果に関連付けられている名前と値の文字列のペアのリスト。これらは、検出結果に追加されるカスタムのユーザー定義フィールドです。これらのフィールドは、特定の設定によって自動的に生成されることがあります。

検出製品では、このフィールドを製品で生成されるデータに使用しないでください。代わりに、調査結果製品はProductFieldsフィールドには、標準の AWS Security Finding Format フィールドにはマップされていないデータが含まれています。

これらのフィールドは、BatchUpdateFindings を使用してのみ更新できます。

タイプ: キーと値のペアのマップ

ペアの最大数: 50

形式: キー名に使用できるのは、文字、数字、および特殊文字 ፦_=+@ のみです。 。 /:

"UserDefinedFields": { "reviewedByCio": "true", "comeBackToLater": "Check this again on Monday" }
VerificationState

オプション

結果の信憑性。検出製品は、このフィールドに値 UNKNOWN を設定できます。検出製品のシステムに有意のアナログが存在する場合、検出製品はこの値を設定する必要があります。このフィールドは一般的に、検出結果調査後のユーザーの決定またはアクションに従って入力されます。

結果プロバイダーはこの属性の初期値を提供できますが、それ以降は更新できません。この属性は、BatchUpdateFindings を使用してのみ更新できます。

タイプ: 列挙型

有効な値:

  • UNKNOWN-セキュリティ検出結果のデフォルトの処理方法は、ユーザーが変更していない場合。

  • TRUE_POSITIVE— セキュリティの検出結果が確認された場合は、ユーザーがこの値を設定します。

  • FALSE_POSITIVE— セキュリティ検出結果が不正なアラームであると判別された場合は、ユーザーがこの値を設定します。

  • BENIGN_POSITIVE— ユーザーはこの値をの特別なケースとして設定します。TRUE_POSITIVE検出結果が脅威を提供しない、予期される、またはその両方が発生する場合です。

Vulnerabilities

オプション

調査結果に適用される脆弱性のリスト。

タイプ: オブジェクトの配列

Workflow

オプション

検出結果の調査ステータスに関する情報を提供します。

ワークフローステータスは、プロバイダーを見つけるためのものではありません。ワークフローのステータスは、BatchUpdateFindings を使用してのみ更新できます。お客様は、コンソールから更新することもできます。「結果のワークフローステータスの設定」を参照してください。

タイプ: オブジェクト

Workflow: { "Status": "NEW" }
WorkflowState (廃止)

オプション

このフィールドは廃止予定になっているため、代わりに Workflow オブジェクトの Status フィールドを使用することをお勧めします。

検出結果のワークフローの状態。検出製品は、このフィールドに値 NEW を設定できます。検出製品のシステムに有意のアナログが存在する場合、検出製品はこのフィールドに値を設定できます。

タイプ: 列挙型

有効な値:

  • NEW— これは、検出結果に関連付けることができます。Activeレコードの状態。これは、新しい検出結果のデフォルトのワークフロー状態です。

  • ASSIGNED— これは、検出結果に関連付けることができます。Activeレコードの状態。検出結果が確認され、レビューまたは対処のために担当者に提供されました。

  • IN_PROGRESS— これは、検出結果に関連付けることができます。Activeレコードの状態。チームメンバーがこの検出結果に対処中です。

  • RESOLVED— これは、検出結果に関連付けることができます。Archivedレコードの状態。これは異なります。DEFERRED結果。検索が再度発生する(ネイティブサービスによって更新される)場合、またはこれに一致する新しい検索が顧客に対して有効な新しい検索として表示されます。

  • DEFERRED— これは、検出結果に関連付けることができます。Archivedレコードの状態。これは、この検出結果に一致する追加の検出結果が、一定期間または無期限に表示されないことを意味します。

    顧客がその検出結果を適用可能と見なしていないか、またはその検出結果がアクティブなデータセットに含める必要のない既知の問題です。

  • DUPLICATE— これは、検出結果に関連付けることができます。Archivedレコードの状態。これは、その結果が別の検出結果の重複であることを意味します。

"WorkflowState": "NEW"

Action

-Actionオブジェクトは、リソースに影響する、またはリソースに対して実行されたアクションに関する詳細を提供します。アクションは、次のいずれかになります。

  • リモート IP アドレスが AWS API 呼び出しを発行しました。

  • DNS 要求を受信しました。

  • リモート IP アドレスが EC2 インスタンスに接続しようとしました。

  • リモート IP アドレスが EC2 インスタンスでポートプローブを試行しました。

"Action": { "ActionType": "PORT_PROBE", "PortProbeAction": { "PortProbeDetails": [ { "LocalPortDetails": { "Port": 80, "PortName": "HTTP" }, "LocalIpDetails": { "IpAddressV4": "192.0.2.0" }, "RemoteIpDetails": { "Country": { "CountryName": "Example Country" }, "City": { "CityName": "Example City" }, "GeoLocation": { "Lon": 0, "Lat": 0 }, "Organization": { "AsnOrg": "ExampleASO", "Org": "ExampleOrg", "Isp": "ExampleISP", "Asn": 64496 } } } ], "Blocked": false } }

Action には、以下の属性を含めることができます。

ActionType

オプション

検出されたアクションの種類。アクションタイプによって、他のどのオブジェクトがActionオブジェクト。

タイプ: 文字列

有効な値: NETWORK_CONNECTION|AWS_API_CALL|DNS_REQUEST|PORT_PROBE

AwsApiCallAction

オプション

含められる場合ActionTypeAWS_API_CALL

検出された API 呼び出しの詳細を提供します。

タイプ: オブジェクト

DnsRequestAction

オプション

含められる場合ActionTypeDNS_REQUEST

検出された DNS 要求の詳細を提供します。

タイプ: オブジェクト

NetworkConnectionAction

オプション

含められる場合ActionTypeNETWORK_CONNECTION

検出されたネットワーク接続の詳細が表示されます。

タイプ: オブジェクト

PortProbeAction

オプション

含められる場合ActionTypePORT_PROBE

検出されたポートプローブに関する詳細を提供します。

タイプ: オブジェクト

AwsApiCallAction

AwsApiCallActionはどのような場合に提供されるActionTypeAWS_API_CALL。検出された API 呼び出しの詳細が表示されます。

AwsApiCallAction には、以下の属性を含めることができます。

AffectedResources

オプション

API コールの影響を受けたのリソースを識別します。

タイプ: キーと値のペアのマップ

Api

オプション

発行された API メソッドの名前。

タイプ: 文字列

CallerType

オプション

API 呼び出しがリモート IP アドレスから発信されたか、DNS ドメインから発信されたかを示します。

タイプ: 文字列

有効な値: domain | remoteIp

DomainDetails

オプション

次の場合に提供されるCallerTypedomain。API 呼び出しが行われた元の DNS ドメインに関する情報を提供します。

タイプ: オブジェクト

FirstSeen

オプション

API コールが最初に検出された日を示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

LastSeen

オプション

API 呼び出しが最後に観察された時刻を示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

RemoteIpDetails

オプション

次の場合に提供されるCallerTyperemoteIp。API コールが行われたリモート IP アドレスに関する情報を提供します。

タイプ: オブジェクト

ServiceName

オプション

API 呼び出しが属する AWS サービス名。

タイプ: 文字列

DomainDetails

DomainDetailsはどのような場合に提供されるAwsApiCallAction.CallerTypedomain。API 呼び出しを発行した DNS ドメインに関する情報を提供します。

DomainDetails には、以下の属性を含めることができます。

Domain

オプション

API 呼び出しを発行した DNS ドメインの名前。

タイプ: 文字列

DnsRequestAction

DnsRequestActionはどのような場合に提供されるActionTypeDNS_REQUEST。検出された DNS 要求の詳細が表示されます。

DnsRequestAction には、以下の属性を含めることができます。

Blocked

オプション

DNS 要求がブロックされたかどうかを示します。

タイプ: ブール値

Domain

オプション

DNS 要求に関連付けられている DNS ドメイン。

タイプ: 文字列

Protocol

オプション

DNS リクエストに使用されたプロトコル。

タイプ: 文字列

NetworkConnectionAction

NetworkConnectionActionはどのような場合に提供されるActionTypeNETWORK_CONNECTION。検出された、試行されたネットワーク接続に関する詳細が表示されます。

NetworkConnectionAction には、以下の属性を含めることができます。

Blocked

オプション

ネットワーク接続の試行がブロックされたかどうかを示します。

タイプ: ブール値

ConnectionDirection

オプション

ネットワーク接続要求の方向。

タイプ: 文字列

有効な値: IN | OUT

LocalPortDetails

オプション

EC2 インスタンスのポートに関する情報。

タイプ: オブジェクト

Protocol

オプション

ネットワーク接続リクエストを行うために使用されるプロトコル。

タイプ: 文字列

RemoteIpDetails

オプション

ネットワーク接続要求を発行したリモート IP アドレスに関する情報。

タイプ: オブジェクト

RemotePortDetails

オプション

リモート IP アドレスのポートに関する情報。

タイプ: オブジェクト

RemotePortDetails

RemotePortDetailsは、試行されたネットワーク接続に関係したリモートポートに関する情報を提供します。

RemotePortDetails には、以下の属性を含めることができます。

Port

オプション

ポートの番号。

タイプ: 整数

PortName

オプション

リモート接続のポート名。

タイプ: 文字列

PortProbeAction

PortProbeActionはどのような場合に提供されるActionTypePORT_PROBE。検出された、試行されたポートプローブに関する詳細が表示されます。

PortProbeAction には、以下の属性を含めることができます。

Blocked

オプション

ポートプローブがブロックされたかどうか。

タイプ: ブール値

PortProbeDetails

オプション

ポートプローブによって影響を受けるポートに関する情報。

タイプ: オブジェクトの配列

PortProbeDetails

PortProbeDetailsには、ポートプローブの一部であったポートスキャンのリストが含まれます。スキャンごとに、PortProbeDetailsは、スキャンされたローカル IP アドレスとポート、およびスキャン元のリモート IP アドレスに関する情報を提供します。

PortProbeDetails には、以下の属性を含めることができます。

LocalIpDetails

オプション

スキャンされたポートが配置されている IP アドレスに関する情報を提供します。

タイプ: オブジェクト

LocalPortDetails

オプション

スキャンされたポートに関する情報を提供します。

タイプ: オブジェクト

RemoteIpDetails

オプション

スキャンを実行したリモート IP アドレスに関する情報を提供します。

タイプ: オブジェクト

LocalIpDetails には、以下の属性を含めることができます。

IpAddressV4

オプション

IP アドレス。

タイプ: 文字列

LocalPortDetails

を使用する場合NetworkConnectionActionおよびPortProbeDetails,LocalPortDetailsは、アクションに関与したローカルポートに関する情報を提供します。

LocalPortDetails には、以下の属性を含めることができます。

Port

オプション

ポートの番号。

タイプ: 整数

PortName

オプション

ローカル接続のポート名。

タイプ: 文字列

RemoteIpDetails

の詳細でAwsApiCallAction,NetworkConnectionAction, およびPortProbeActionとすると、RemoteIpDetailsオブジェクトは、アクションに関与したリモート IP アドレスに関する情報を提供します。

RemoteIpDetails には、以下の属性を含めることができます。

City

オプション

リモート IP アドレスが配置されている市。

タイプ: オブジェクト

Country

オプション

リモート IP アドレスが配置されている国。

タイプ: オブジェクト

Geolocation

オプション

リモート IP アドレスの位置の座標。

タイプ: オブジェクト

IpAddressV4

オプション

IP アドレス。

タイプ: 文字列

Organization

オプション

リモート IP アドレスに関連付けられているインターネットサービスプロバイダー (ISP) 組織。

タイプ: オブジェクト

City

Cityには、リモート IP アドレスがある都市に関する情報が含まれています。

City には、以下の属性を含めることができます。

CityName

オプション

リモート IP アドレスが配置されている市区町村。

タイプ: 文字列

Country

Countryは、リモート IP アドレスがある国を示します。

Country には、以下の属性を含めることができます。

CountryCode

オプション

リモート IP アドレスがある国の 2 文字の ISO 3166 国コード。

タイプ: 文字列

CountryName

オプション

リモート IP アドレスが配置されている国の名前。

タイプ: 文字列

Geolocation

Geolocationリモート IP アドレスの場所の緯度座標と経度座標を入力します。

Geolocation には、以下の属性を含めることができます。

Lat

オプション

リモート IP アドレスの位置の緯度です。

タイプ: Double

Lon

オプション

リモート IP アドレスの位置の経度です。

タイプ: Double

Organization

Organizationリモート IP アドレスに関連付けられている ISP 組織を識別します。

Organization には、以下の属性を含めることができます。

Asn

オプション

リモート IP アドレスのインターネットプロバイダーの自律システム番号 (ASN)。

タイプ: 文字列

AsnOrg

オプション

ASNを登録した組織の名前。

タイプ: 文字列

Isp

オプション

インターネットプロバイダーの ISP 情報。

タイプ: 文字列

Org

オプション

インターネットプロバイダーの名前。

タイプ: 文字列

Compliance

コントロールに関連する検出結果の詳細が含まれます。コントロールで実行されるチェックの結果として生成された検出結果に対してのみ返されます。

"Compliance": { "RelatedRequirements": ["Req1", "Req2"], "Status": "FAILED", "StatusReasons": [ { "ReasonCode": "CLOUDWATCH_ALARMS_NOT_PRESENT", "Description": "CloudWatch alarms do not exist in the account" } ] }

Compliance オブジェクトには、次の属性を含めることができます。

RelatedRequirements

オプション

Security Hub コントロールの場合、コントロールに関連する業界または規制フレームワークの要件。そのコントロールのチェックは、それらの要件に沿って行われます。

最大 32 個の関連要件を指定できます。

要件を識別するには、その識別子を使用します。

タイプ: 文字列の配列

Status

オプション

セキュリティチェックの結果。

タイプ: 列挙型

有効な値:

  • PASSED— 評価されたすべてのリソースがセキュリティチェックに合格しました。もし Compliance.StatusPASSEDに設定されている場合、Security Hub は自動的にWorkflow.StatusRESOLVED

    もしCompliance.Statusから発見の変更のためのPASSEDFAILED,WARNING, またはNOT_AVAILABLE, およびWorkflow.StatusのいずれかであったNOTIFIEDまたはRESOLVEDに設定されている場合、Security Hub は自動的にWorkflow.StatusNEW

  • WARNING— 不足している情報があるか、設定に対するこのチェックはサポートされていません。

  • FAILED— 評価された 1 つ以上のリソースがセキュリティチェックに合格しませんでした。

  • NOT_AVAILABLE— サービスの停止または API エラーのため、チェックを実行できませんでした。-NOT_AVAILABLEステータスが AWS Config 評価の結果がNOT_APPLICABLE。その場合は、3 日後に、Security Hub によって検出結果がアーカイブされます。

"Status": "PASSED"
StatusReasons

オプション

コントロールから生成された検出結果の場合、Compliance.Status の値の背後にある理由のリスト。

ステータスコードとその意味のリストについては、「ASFF のコントロール関連情報」を参照してください。

タイプ: 文字列

例:

"StatusReasons": [ { "Description": "CloudWatch alarms do not exist in the account", "ReasonCode": "CW_ALARMS_NOT_PRESENT" } ]

StatusReasons

コントロールから生成された検出結果の場合、Compliance.Status の値の理由のリスト。

"StatusReasons": [ { "Description": "CloudWatch alarms do not exist in the account", "ReasonCode": "CW_ALARMS_NOT_PRESENT" } ]

StatusReasons オブジェクト内の各理由には、次の属性を含めることができます。

Description

オプション

理由に対応する説明。

タイプ: 文字列

ReasonCode

必須

現在のコントロールステータスの理由を表すコード。

タイプ: 文字列

使用可能なステータスコードとその意味のリストについては、「セキュリティチェックの結果」を参照してください。

FindingProviderFields

BatchImportFindings要求、検索プロバイダはFindingProviderFieldsによってのみ更新されるべき属性の値を提供するためにBatchUpdateFindings

Security Hub による更新の処理方法の詳細については、BatchImportFindingsFindingProviderFieldsおよび対応するトップレベルの属性については、を使用する FindingProviderFields

"FindingProviderFields": { "Confidence": 42, "Criticality": 99, "RelatedFindings":[ { "ProductArn": "arn:aws:securityhub:us-west-2::product/aws/guardduty", "Id": "123e4567-e89b-12d3-a456-426655440000" } ], "Severity": { "Label": "MEDIUM", "Original": "MEDIUM" }, "Types": [ "Software and Configuration Checks/Vulnerabilities/CVE" ] }

FindingProviderFieldsには、次の属性を含めることができます。

Confidence

オプション

検出結果の信頼度。信頼度は、検出結果が、識別することが意図されていた動作や問題を正確に識別する可能性として定義されます。

タイプ: 整数 (0 ~ 100)

Confidenceは、比率スケールを使用して 0 ~ 100 ベースでスコア付けされます。0 は 0% の信頼度、100 は 100% の信頼度を表します。

Criticality

オプション

検出結果に関連付けられているリソースに割り当てられている重要度。スコア 0 は、基になるリソースに重要性がなく、スコア 100 は最も重要なリソース用に予約されています。

タイプ: 整数

最小値はです。 0

値の最大長 100

Criticalityは、完全な整数のみをサポートする比率スケールを使用して、0 ~ 100 ベースでスコア付けされます。スコア 0 は、基になるリソースに重要性がなく、スコア 100 は最も重要なリソース用に予約されています。

RelatedFindings

オプション

関連する検出結果のリスト。

タイプ: の配列RelatedFindingobjects

オブジェクトの最大数: 10

Severity

必須

検出結果の重要度に関する詳細。

プロバイダーを検索するには、SeverityのオブジェクトFindingProviderFieldsの値を提供するためにLabelおよびOrigin

使用可能な値の詳細については、LabelおよびOrigin、および重大度の評価方法に関するガイダンスについては、Severityオブジェクト

タイプ: オブジェクト

Types

必須

形式の 1 つ以上の検出結果タイプ名前空間/カテゴリ/分類子それは発見を分類します。

タイプ: 文字列の配列

文字列の最大数: 50

Malware

-Malwareオブジェクトは、検出結果に関連するマルウェアのリストを提供します。これは、最大 5 個のマルウェアオブジェクトを含めることができる配列です。

"Malware": [ { "Name": "Stringler", "Type": "COIN_MINER", "Path": "/usr/sbin/stringler", "State": "OBSERVED" } ]

各マルウェアオブジェクトには、次の属性を含めることができます。

Name

必須

検出されたマルウェアの名前。

タイプ: 文字列

最大長: 64

"Name": "Stringler"
Path

オプション

検出されたマルウェアのファイルパス。

タイプ: 文字列

最大長: 512

"Path": "/usr/sbin/stringler"
State

オプション

検出されたマルウェアの状態。

タイプ: 列挙型

有効な値: OBSERVED | REMOVAL_FAILED | REMOVED

"State": "OBSERVED"
Type

オプション

検出されたマルウェアのタイプ。

タイプ: 列挙型

有効な値: ADWARE|BLENDED_THREAT|BOTNET_AGENT|COIN_MINER|EXPLOIT_KIT|KEYLOGGER|MACRO|POTENTIALLY_UNWANTED|SPYWARE|RANSOMWARE|REMOTE_ACCESS|ROOTKIT|TROJAN|VIRUS|WORM

"Type": "COIN_MINER"

Network (廃止)

検出結果に関するネットワーク関連情報の詳細。

このオブジェクトは廃止されました。このデータを提供するには、そのデータをResourcesを使用するかActionオブジェクト。

"Network": { "Direction": "IN", "OpenPortRange": { "Begin": 443, "End": 443 }, "Protocol": "TCP", "SourceIpV4": "1.2.3.4", "SourceIpV6": "FE80:CD00:0000:0CDE:1257:0000:211E:729C", "SourcePort": "42", "SourceDomain": "example1.com", "SourceMac": "00:0d:83:b1:c0:8e", "DestinationIpV4": "2.3.4.5", "DestinationIpV6": "FE80:CD00:0000:0CDE:1257:0000:211E:729C", "DestinationPort": "80", "DestinationDomain": "example2.com" }

Network オブジェクトには、次の属性を含めることができます。

DestinationDomain

オプション

検出結果に関するネットワーク関連情報の送信先ドメイン。

タイプ: 文字列

最大長: 128

"DestinationDomain": "there.com"
DestinationIpV4

オプション

検出結果に関するネットワーク関連情報の送信先 IPv4 アドレス。

タイプ: IPv4

"DestinationIpV4": "2.3.4.5"
DestinationIpV6

オプション

検出結果に関するネットワーク関連情報の送信先 IPv6 アドレス。

タイプ: IPv6

"DestinationIpV6": "FE80:CD00:0000:0CDE:1257:0000:211E:729C"
DestinationPort

オプション

検出結果に関するネットワーク関連情報の送信先ポート。

タイプ: 数値

有効な値: 範囲は 0~65535

"DestinationPort": "80"
Direction

オプション

検出結果に関連付けられるネットワークトラフィックの方向。

タイプ: 列挙型

有効な値: IN | OUT

"Direction": "IN"
OpenPortRange

オプション

ネットワーク内に存在するオープンポートの範囲。

タイプ: オブジェクト

Protocol

オプション

検出結果に関するネットワーク関連情報のプロトコル。

タイプ: 文字列

最大長: 16

検出製品がより正確なプロトコルを判別できる場合を除き、名前は関連付けられているポートの IANA 登録名である必要があります。

"Protocol": "TCP"
SourceDomain

オプション

検出結果に関するネットワーク関連情報の送信元ドメイン。

タイプ: 文字列

最大長: 128

"SourceDomain": "here.com"
SourceIpV4

オプション

検出結果に関するネットワーク関連情報の送信元 IPv4 アドレス。

タイプ: IPv4

"SourceIpV4": "1.2.3.4"
SourceIpV6

オプション

検出結果に関するネットワーク関連情報の送信元 IPv6 アドレス。

タイプ: IPv6

"SourceIpV6": "FE80:CD00:0000:0CDE:1257:0000:211E:729C"
SourceMac

オプション

検出結果に関するネットワーク関連情報の送信元メディアアクセスコントロール (MAC) アドレス。

タイプ: 文字列

形式: 一致する必要がありますMM:MM:MM:SS:SS:SS

"SourceMac": "00:0d:83:b1:c0:8e"
SourcePort

オプション

検索結果に関するネットワーク関連情報の送信元ポート。

タイプ: 数値

有効な値: 範囲は 0~65535

"SourcePort": "80"

OpenPortRange

開いているポート範囲の開始ポートと終了ポートを提供します。

OpenPortRange には、以下の属性を含めることができます。

Begin

オプション

ポート範囲の最初のポート。

タイプ: 整数

End

オプション

ポート範囲の最後のポート。

タイプ: 整数

NetworkPath

-NetworkPathオブジェクトは、検索結果に関連するネットワークパスに関する情報を提供します。下の各エントリNetworkPathはそのパスのコンポーネントを表します。

"NetworkPath" : [ { "ComponentId": "abc-01a234bc56d8901ee", "ComponentType": "AWS::EC2::InternetGateway", "Egress": { "Destination": { "Address": [ "192.0.2.0/24" ], "PortRanges": [ { "Begin": 443, "End": 443 } ] }, "Protocol": "TCP", "Source": { "Address": ["203.0.113.0/24"] } }, "Ingress": { "Destination": { "Address": [ "198.51.100.0/24" ], "PortRanges": [ { "Begin": 443, "End": 443 } ] }, "Protocol": "TCP", "Source": { "Address": [ "203.0.113.0/24" ] } } } ]

ネットワークパスの各コンポーネントには、次の属性を含めることができます。

ComponentId

必須

ネットワークパス内のコンポーネントの識別子。

タイプ: 文字列

ComponentType

必須

コンポーネントのタイプ。

タイプ: 文字列

Egress

オプション

ネットワークパス内の現在のコンポーネントの後に来るコンポーネントに関する情報。

タイプ: オブジェクト

Ingress

オプション

ネットワークパス内の現在のコンポーネントの前に来るコンポーネントに関する情報。

タイプ: オブジェクト

Egress

-Egressオブジェクトには、ネットワークパス内の現在のコンポーネントの後に来るコンポーネントに関する情報が含まれています。これには、次の属性を含めることができます。

Destination

オプション

コンポーネントの宛先に関する情報。

タイプ: オブジェクト

Protocol

オプション

コンポーネントに使用されるプロトコル。

タイプ: 文字列

Source

オプション

コンポーネントの原点に関する情報です。

タイプ: オブジェクト

Ingress

-Ingressオブジェクトには、ネットワークパスにある前のコンポーネントに関する情報が含まれています。これには、次の属性を含めることができます。

Destination

オプション

前のコンポーネントの宛先に関する情報。

タイプ: オブジェクト

Protocol

オプション

前のコンポーネントによって使用されるプロトコルです。

タイプ: 文字列

Source

オプション

前のコンポーネントの原点に関する情報。

タイプ: オブジェクト

Destination

-DestinationのオブジェクトEgressまたはIngressには、前または次のコンポーネントの宛先情報が含まれます。これには、次の属性を含めることができます。

Address

オプション

前のコンポーネントまたは次のコンポーネントの IP アドレス。

タイプ: 文字列の配列

PortRanges

オプション

前または次のコンポーネントの宛先に対して開いているポート範囲のリスト。

タイプ: オブジェクトの配列

PortRanges.Begin

オプション

開いているポート範囲の場合、範囲の先頭です。

タイプ: 整数

PortRanges.End

オプション

開いているポート範囲の場合、範囲の終わり。

タイプ: 数値

Source

-SourceオブジェクトのあるEgressまたはIngress前のコンポーネントまたは次のコンポーネントのオリジンに関する情報が含まれています。これには、次の属性を含めることができます。

Address

オプション

前または次のコンポーネントの発信元の IP アドレス。

タイプ: 文字列の配列

PortRanges

オプション

前のコンポーネントまたは次のコンポーネントの起点の開いているポート範囲のリスト。

タイプ: オブジェクトの配列

PortRanges.Begin

オプション

開いているポート範囲の場合、範囲の先頭です。

タイプ: 整数

PortRanges.End

オプション

開いているポート範囲の場合、範囲の終わり。

タイプ: 数値

Note

Note オブジェクトによってユーザー定義のメモが検出結果に追加されます。

検出結果プロバイダーは、検出結果の最初のメモを提供できますが、それ以降にメモを追加することはできません。注意は、BatchUpdateFindings を使用してのみ更新できます。

"Note": { "Text": "Don't forget to check under the mat.", "UpdatedBy": "jsmith", "UpdatedAt": "2018-08-31T00:15:09Z" }

Note オブジェクトには、次の属性を含めることができます。

Text

必須

検索結果メモのテキスト。

タイプ: 文字列

最大長: 512

"Text": "Example text."
UpdatedAt

必須

メモが更新された日時を示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"UpdatedAt": "2018-08-31T00:15:09Z"
UpdatedBy

必須

メモを作成したプリンシパル。

タイプ: string または ARN

最大長: 512

"UpdatedBy": "jsmith"

PatchSummary

-PatchSummaryオブジェクトには、選択したコンプライアンス標準に対するインスタンスのパッチコンプライアンスステータスの概要が表示されます。

"PatchSummary" : { "Id" : "pb-123456789098" "InstalledCount" : "100", "MissingCount" : "100", "FailedCount" : "0", "InstalledOtherCount" : "1023", "InstalledRejectedCount" : "0", "InstalledPendingReboot" : "0", "OperationStartTime" : "2018-09-27T23:37:31Z", "OperationEndTime" : "2018-09-27T23:39:31Z", "RebootOption" : "RebootIfNeeded", "Operation" : "Install" }

PatchSummary オブジェクトには、次の属性を含めることができます。

FailedCount

オプション

インストールに失敗したコンプライアンス標準からのパッチの数。

タイプ: 数値

最小値はです。 0

値の最大長 100,000

Id

必須

パッチの準拠ステータスを決定するために使用された準拠標準の識別子。

タイプ: 文字列

最小長: 20

最大長: 128

InstalledCount

オプション

正常にインストールされたコンプライアンス標準からのパッチの数。

タイプ: 数値

最小値はです。 0

値の最大長 100,000

InstalledOtherCount

オプション

コンプライアンス標準に含まれていない、インストールされているパッチの数。

タイプ: 数値

最小値はです。 0

値の最大長 100,000

InstalledPendingReboot

オプション

適用されたが、インストール済みとしてマークするためにインスタンスを再起動する必要があるパッチの数。

タイプ: 数値

最小値はです。 0

値の最大長 100,000

InstalledRejectedCount

オプション

インストールされているが、お客様が拒否したパッチのリストにも含まれているパッチの数。

タイプ: 数値

最小値はです。 0

値の最大長 100,000

MissingCount

オプション

コンプライアンス標準の一部であるが、インストールされていないパッチの数。この数には、インストールに失敗したパッチが含まれます。

タイプ: 数値

最小値はです。 0

値の最大長 100,000

Operation

オプション

実行されたパッチ操作のタイプ。

パッチマネージャの場合、値はSCANおよびINSTALL

タイプ: 文字列

最大長: 256

OperationEndTime

オプション

操作が完了したことを示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"OperationEndTime": "2020-06-22T17:40:12.322Z"
OperationStartTime

オプション

オペレーションがいつ開始されたかを示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"OperationStartTime": "2020-06-22T17:40:12.322Z"
RebootOption

オプション

インスタンスに指定された再起動オプション。

タイプ: 文字列

最大長: 256

有効な値: NoReboot|RebootIfNeeded

Process

Process オブジェクトは、検出結果に関するプロセス関連の詳細を提供します。

"Process": { "Name": "syslogd", "Path": "/usr/sbin/syslogd", "Pid": 12345, "ParentPid": 56789, "LaunchedAt": "2018-09-27T22:37:31Z", "TerminatedAt": "2018-09-27T23:37:31Z" }

Process オブジェクトには、次の属性を含めることができます。

LaunchedAt

オプション

プロセスがいつ開始されたかを示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"LaunchedAt": "2018-09-27T22:37:31Z"
Name

オプション

プロセスの名前。

タイプ: 文字列

最大長: 64

"Name": "syslogd"
ParentPid

オプション

親プロセス ID。

タイプ: 数値

"ParentPid": 56789
Path

オプション

実行可能プロセスへのパス。

タイプ: 文字列

最大長: 512

"Path": "/usr/sbin/syslogd"
Pid

オプション

プロセス ID。

タイプ: 数値

"Pid": 12345
TerminatedAt

オプション

プロセスがいつ終了したかを示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"TerminatedAt": "2018-09-27T23:37:31Z"

RelatedFindings

RelatedFindings オブジェクトは、現在の検出結果に関連する検出結果のリストを提供します。

を使用する場合BatchImportFindings要求を使用する場合、検索プロバイダーはRelatedFindingsオブジェクトのあるFindingProviderFields

"RelatedFindings": [ { "ProductArn": "arn:aws:securityhub:us-west-2::product/aws/guardduty", "Id": "123e4567-e89b-12d3-a456-426655440000" }, { "ProductArn": "arn:aws:securityhub:us-west-2::product/aws/guardduty", "Id": "AcmeNerfHerder-111111111111-x189dx7824" } ]

関連する検出結果の各オブジェクトには、次の属性を含めることができます。

Id

必須

関連する検出結果の、製品によって生成された識別子。

タイプ: string または ARN

最大長: 512

"Id": "123e4567-e89b-12d3-a456-426655440000"
ProductArn

必須

関連する検出結果を生成した製品の ARN。

タイプ: ARN

"ProductArn": "arn:aws:securityhub:us-west-2::product/aws/guardduty"

Remediation

Remediation オブジェクトは、検出結果に対処するために推奨される修復手順に関する情報を提供します。

"Remediation": { "Recommendation": { "Text": "Run sudo yum update and cross your fingers and toes.", "Url": "http://myfp.com/recommendations/dangerous_things_and_how_to_fix_them.html" } }

Remediation オブジェクトには、次の属性を含めることができます。

Recommendation

オプション

検出結果内で特定された問題の修正方法に関する推奨事項。

Recommendation フィールドは、検出結果を解決するための手動の手順または詳細を容易にするためのものです。

推奨オブジェクトが存在する場合は、Text フィールドまたは Url フィールドが存在し、データが入力されている必要があります。両方のフィールドが存在し、データを入力することができます。

タイプ: オブジェクト

"Recommendation": { "Text": "Example text.", "Url": "http://myfp.com/recommendations/dangerous_things_and_how_to_fix_them.html" }

Recommendation

Recommendation オブジェクトには、次の属性を含めることができます。

Text

オプション

ユーザーに向けて表示する、検出結果への対処法の推奨事項を記述する自由形式の文字列。このフィールドに指定できるのは、固有ではない共通のテキストまたは検出結果のこのインスタンスに固有の詳細です。

タイプ: 文字列

最大長: 512

"Text": "Example text."
Url

オプション

その検出結果タイプの一般的な修復の情報にリンクする URL。

この URL は、アクセスするために資格情報を求めないこと、パブリックインターネットからアクセス可能であること、およびいかなるコンテキストやセッションも期待しないことが必要です。

タイプ: URL

"Url": "http://myfp.com/recommendations/example_domain.html"

Resources

Resources オブジェクトは、検出結果に関連するリソースに関する情報を提供します。

これには、最大 32 個のリソースオブジェクトの配列が含まれます。

"Resources": [ { "Type": "AwsEc2Instance", "Id": "arn:aws:ec2:us-west-2:111122223333:instance/i-1234567890abcdef0", "Partition": "aws", "Region": "us-west-2", "ResourceRole": "TARGET", "Tags": { "billingCode": "Lotus-1-2-3", "needsPatching": "true" }, "Details": { "AwsEc2Instance": { "Type": "i3.xlarge", "ImageId": "ami-abcd1234", "IpV4Addresses": [ "54.194.252.215", "192.168.1.88" ], "IpV6Addresses": [ "2001:db8:1234:1a2b::123" ], "KeyName": "my_keypair", "IamInstanceProfileArn": "arn:aws:iam::111111111111:instance-profile/AdminRole", "VpcId": "vpc-11112222", "SubnetId": "subnet-56f5f633", "LaunchedAt": "2018-05-08T16:46:19.000Z" } } } ]

各リソースオブジェクトには、次の属性を含めることができます。

DataClassification

オプション

リソースで検出された機密データに関する詳細を提供するために使用されます。

タイプ: オブジェクト

Details

オプション

このフィールドは、適切なオブジェクトを使用する 1 つのリソースに関する追加の詳細を提供します。

検出サイズが 240 KB の最大値を超えると、Detailsオブジェクトが、結果から削除されます。AWS Config ルールを使用するコントロールの結果については、AWS Config コンソールでリソースの詳細を表示できます。

各リソースは、Resourcesオブジェクト。

Security Hub には、そのサポートされているリソースタイプに使用できるオブジェクトのセットが用意されています。これらのオブジェクトは、リソースの値に対応します。Type。可能な限り、提供されたタイプとオブジェクトを使用してください。

たとえば、リソースが S3 バケットの場合、リソースTypeAwsS3Bucketをクリックし、リソースの詳細をAwsS3Bucketサブフィールドに入力します。

Other サブフィールドでは、カスタムのフィールドおよび値を指定できます。Other サブフィールドは、次の場合に使用します。

  • リソースタイプ (リソース Type の値) に対応するサブフィールドがない場合。リソースの詳細を指定するには、 Other 詳細サブフィールドを使用します。

  • リソースタイプのサブフィールドに、入力するすべてのフィールドが含まれているわけではない場合。この場合は、リソースタイプのサブフィールドを使用して、使用可能なフィールドを挿入します。Other サブフィールドを使用して、タイプ固有のサブフィールドにないフィールドを挿入します。

  • リソースタイプが提供されたタイプのいずれでもない場合。この場合、リソース TypeOther に設定し、Other 詳細サブフィールドを使用して詳細を挿入します。

タイプ: オブジェクト

"Details": { "AwsEc2Instance": { "Type": "i3.xlarge", "ImageId": "ami-abcd1234", "IpV4Addresses": [ "54.194.252.215", "192.168.1.88" ], "IpV6Addresses": [ "2001:db8:1234:1a2b::123" ], "KeyName": "my_keypair", "IamInstanceProfileArn": "arn:aws:iam::111111111111:instance-profile/AdminRole", "VpcId": "vpc-11112222", "SubnetId": "subnet-56f5f633", "LaunchedAt": "2018-05-08T16:46:19.000Z" }, "AwsS3Bucket": { "OwnerId": "da4d66eac431652a4d44d490a00500bded52c97d235b7b4752f9f688566fe6de", "OwnerName": "acmes3bucketowner" }, "Other": [ { "Key": "LightPen", "Value": "blinky" }, { "Key": "SerialNo", "Value": "1234abcd" } ] }
Id

必須

指定されたリソースタイプの正規の識別子。

ARN で識別される AWS リソースの場合、これは ARN である必要があります。

ARN が欠落しているその他すべての AWS リソースタイプの場合、これはリソースを作成した AWS サービスで定義されている識別子である必要があります。

AWS 以外のリソースの場合、これはリソースに関連付けられている一意の識別子である必要があります。

タイプ: string または ARN

最大長: 512

"Id": "arn:aws:s3:::example-bucket"
Partition

オプション

リージョンが割り当てられている正規 AWS パーティション名。

タイプ: 列挙型

有効な値:

パーティション

説明

aws

その他のすべてのリージョン

aws-cn

中国

aws-us-gov

AWS GovCloud (米国)

"Partition": "aws"
Region

オプション

このリソースが配置されている正規の AWS 外部リージョン名。

タイプ: 文字列

最大長: 16

"Region": "us-west-2"
ResourceRole

オプション

結果におけるリソースの役割を識別します。リソースは、検索アクティビティのターゲットです。

タイプ: 文字列

有効な値: ACTOR | TARGET

Tags

オプション

検出結果が処理された時点でリソースに関連付けられた AWS タグのリスト。タグが関連付けられているリソースの場合のみ、Tags 属性を含めます。リソースにタグが関連付けられていない場合は、検出結果に Tags 属性を含めないでください。

タイプ: タグのマップ

タグの最大数: 50

値あたりの最大長: 256

タグには以下のような基本制限があります。

  • このフィールドには、AWS リソースに実際に存在するタグのみを指定できます。AWS Security Finding 形式で定義されていないリソースタイプのデータを提供するには、Other[詳細] サブフィールド。

  • 値は、次の文字に制限されます。A ~ z、a ~ z、0 ~ 9、0 ~ 9、0 ~ 9、および.: + = @ _/-(ハイフン)。

  • 値の最大長は、AWS タグ値の長さである 256 文字です。

"Tags": { "billingCode": "Lotus-1-2-3", "needsPatching": "true" }
Type

必須

詳細を提供しているリソースのタイプ。

可能な限り、提供されているリソースタイプの 1 つ(AwsEc2Instance または AwsS3Bucket など)を使用します。

リソースタイプが提供されているリソースタイプのいずれにも一致しない場合は、リソースのTypeOtherとし、Other[details] サブフィールドをクリックして、詳細を設定します。

タイプ: 文字列

最大長: 256

サポートされている値は次のとおりです。タイプに対応するサブフィールドがある場合、そのサブフィールドの詳細を表示するには、タイプ名を選択します。

"Type": "AwsS3Bucket"

DataClassification

-DataClassificationオブジェクトには、リソースで検出された機密データに関する情報が含まれています。

"DataClassification": { "DetailedResultsLocation": "Path_to_Folder_Or_File", "Result": { "MimeType": "text/plain", "SizeClassified": 2966026, "AdditionalOccurrences": false, "Status": { "Code": "COMPLETE", "Reason": "Unsupportedfield" }, "SensitiveData": [ { "Category": "PERSONAL_INFORMATION", "Detections": [ { "Count": 34, "Type": "GE_PERSONAL_ID", "Occurrences": { "LineRanges": [ { "Start": 1, "End": 10, "StartColumn": 20 } ], "Pages": [], "Records": [], "Cells": [] } }, { "Count": 59, "Type": "EMAIL_ADDRESS", "Occurrences": { "Pages": [ { "PageNumber": 1, "OffsetRange": { "Start": 1, "End": 100, "StartColumn": 10 }, "LineRange": { "Start": 1, "End": 100, "StartColumn": 10 } } ] } }, { "Count": 2229, "Type": "URL", "Occurrences": { "LineRanges": [ { "Start": 1, "End": 13 } ] } }, { "Count": 13826, "Type": "NameDetection", "Occurrences": { "Records": [ { "RecordIndex": 1, "JsonPath": "$.ssn.value" } ] } }, { "Count": 32, "Type": "AddressDetection" } ], "TotalCount": 32 } ], "CustomDataIdentifiers": { "Detections": [ { "Arn": "1712be25e7c7f53c731fe464f1c869b8", "Name": "1712be25e7c7f53c731fe464f1c869b8", "Count": 2, } ], "TotalCount": 2 } } }

DataClassificationには、以下の属性を含めることができます。

DetailedResultsLocation

オプション

機密データを含むフォルダまたはファイルへのパス。

タイプ: 文字列

Result

オプション

リソースで検出された機密データの詳細。

タイプ: オブジェクト

Result

-Resultオブジェクトには、リソースで検出された機密データの詳細が含まれます。

Result には、以下の属性を含めることができます。

AdditionalOccurrences

オプション

結果に含まれていない機密データの追加出現があるかどうかを示します。これは、出現回数が含めることができる最大値を超えた場合に発生します。

タイプ: ブール値

CustomDataIdentifiers

オプション

お客様が定義した構成に基づいて識別された機密データに関する詳細を提供します。

タイプ: オブジェクト

MimeType

オプション

結果条件が適用されるコンテンツのタイプ。

タイプ: 文字列

必要な形式: MIME タイプである必要があります。

  • application/gzip, GNU Gzip圧縮アーカイブファイル

  • application/pdf、アドビのポータブルドキュメント形式(.pdf) ファイル

SensitiveData

オプション

組み込みの構成に基づいて識別された機密データに関する詳細を提供します。

タイプ: オブジェクト

SizeClassified

オプション

影響を受けるデータの合計サイズ (バイト単位)。

タイプ: Long

Status

オプション

検出の現在のステータスに関する詳細を入力します。

タイプ: オブジェクト

Status.Code

オプション

機密データ検出のステータスを表すコード。

タイプ: 文字列

Status.Reason

オプション

機密データ検出の現在のステータスのより長い説明。

タイプ: 文字列

CustomDataIdentifiers

CustomDataIdentifiersには、ユーザー定義の識別子によって検出された機密データのインスタンスが格納されます。

CustomDataIdentifiers には、以下の属性を含めることができます。

Detections

オプション

検出された機密データのインスタンスのリスト。

タイプ: オブジェクトの配列

TotalCount

オプション

機密データの発生数の合計。

タイプ: 整数

SensitiveData

SensitiveDataには、組み込み識別子に基づく機密データの検出されたインスタンスが格納されます。

Category

オプション

検出された機密データのカテゴリ。たとえば、機密データには資格情報、財務情報、または個人情報が含まれていることを示すカテゴリがあります。

タイプ: 文字列

Detections

オプション

検出された機密データのインスタンスのリスト。

タイプ: オブジェクトの配列

TotalCount

オプション

機密データの発生数の合計。

タイプ: 整数

Detections

Detections検出された機密データの詳細が含まれます。

検出された機密データの各インスタンスには、次の属性を含めることができます。

Arn

オプション

機密データの検出に使用されたカスタム識別子の ARN。

Arnで提供されるのはDetectionsCustomDataIdentifiersDetectionsSensitiveDataがありません。Arn属性。

タイプ: 文字列

Count

オプション

検出された機密データの出現の総数。

タイプ: 整数

Name

オプション

機密データを検出したカスタム識別子の名前。

Nameで提供されるのはDetectionsCustomDataIdentifiersDetectionsSensitiveDataがありません。Name属性。

タイプ: 文字列

Occurrences

オプション

検出された機密データの詳細。Occurrencesには、次のオブジェクトを含めることができます。これらの各オブジェクトには、オブジェクトの配列が格納されます。

  • Cells— Microsoft Excel ファイルで検出された機密データの出現を、コンマ区切り値 (.csv) ファイル、またはタブ区切りの値 (.tsv) ファイル

  • LineRanges— 非検出で検出された機密データの発生を含むバイナリテキストファイルまたは Word ファイル

  • OffsetRanges— バイナリテキストファイルで検出された機密データを含む

  • Pages— Adobe ポータブルドキュメント形式で検出された機密データが含まれています (.pdf) ファイル

  • Records— Apache Avro オブジェクトコンテナまたは Apache Parquet ファイルで検出された機密データの発生を含む

タイプ: オブジェクト

Type

オプション

検出された機密データの種類。たとえば、タイプは、データが電子メールアドレスであることを示す可能性があります。

Typeで提供されるのはDetectionsSensitiveDataDetectionsCustomDataIdentifiersがありません。Type属性。

タイプ: 文字列

Cells

Cellsには、Microsoft Excel ブックで検出された機密データ、コンマ区切り値 (.csv) ファイル、またはタブ区切りの値 (.tsv) ファイルを開きます。

オカレンスごとにCellsは、機密データを含むセルを識別します。

各オカレンスは、次の属性を含めることができます。

CellReference

オプション

Microsoft Excel ブックの場合は、データを含むセルの位置を、絶対セル参照として指定します。たとえば、シート 2 と指定します。 シート 2 のセル C5 の C5 です。

この属性は、.csvおよび.tsvfile.

タイプ: 文字列

Column

オプション

データを含む列の列番号。Microsoft Excel ブックの場合、列番号はアルファベット順の列識別子に対応します。たとえば、値 1 はColumnは、ブックの [A] 列に対応します。

タイプ: 整数

ColumnName

オプション

データが含まれている列の名前。

タイプ: 文字列

Row

オプション

データを含む行の行番号。

タイプ: 整数

LineRanges

LineRangesには、非バイナリテキストファイルまたは Microsoft Word ファイルで検出された機密データが含まれています。非バイナリテキストファイルには、.html,.xml,.json, および.txtfile.

オカレンスごとにLineRangesは、機密データの場所を提供します。場所には、データが配置されている行と、その行上のデータの位置が含まれます。

各オカレンスは、次の属性を含めることができます。

End

オプション

ファイルの先頭から機密データの末尾までの行数。

タイプ: 整数

Start

オプション

ファイルの先頭から機密データの末尾までの行数。

タイプ: 整数

開始列

オプション

機密データが始まる行で、機密データが始まる行内の列。

タイプ: 整数

OffsetRanges

OffsetRangesには、バイナリテキストファイルで検出された機密データが含まれています。

オカレンスごとにOffsetRangesは、機密データの場所を提供します。場所は、ファイルの先頭を基準とした文字数です。

各オカレンスは、次の属性を含めることができます。

End

オプション

ファイルの先頭から機密データの末尾までの文字数。

タイプ: 整数

Start

オプション

ファイルの先頭から機密データの先頭までの文字数。

タイプ: 整数

StartColumn

オプション

機密データが始まる列。

タイプ: 整数

Pages

Pagesは、Adobe ポータブルドキュメント形式(.pdf) ファイルを開きます。

オカレンスごとにPagesは、データを含むページを識別し、ページ上のデータの位置を示します。位置は、行番号または文字番号のいずれかを使用して識別できます。

各オカレンスは、次の属性を含めることができます。

LineRange

オプション

行番号を使用して、機密データの場所を特定します。

タイプ: オブジェクト

LineRange.End

オプション

ファイルの先頭から機密データの末尾までの行数。

タイプ: 整数

LineRange.Start

オプション

ファイルの先頭から機密データの先頭までの行数。

タイプ: 整数

LineRange.StartColumn

オプション

機密データが始まる行で、機密データが始まる列番号。

タイプ: 整数

OffsetRange

オプション

文字数に基づいて、機密データの場所を特定します。

タイプ: オブジェクト

OffsetRange.End

オプション

ファイルの先頭から機密データの末尾までの文字数。

タイプ: 整数

OffsetRange.Start

オプション

ファイルの先頭から機密データの先頭までの文字数。

タイプ: 整数

OffsetRange.StartColumn

オプション

機密データが開始する行で、開始する列番号。

タイプ: 整数

PageNumber

オプション

機密データを含むページのページ番号。

タイプ: 整数

Records

Recordsは、Apache Avro オブジェクトコンテナまたは Apache Parquet ファイル内の機密データの出現を識別します。

オカレンスごとにRecordsは、レコードのインデックスと、機密データを含むフィールドへのパスを指定します。

各オカレンスは、次の属性を含めることができます。

JsonPath

オプション

データが格納されているレコード内のフィールドへのパス (JSONPath 式)。フィールド名が 20 文字より長い場合は切り捨てられます。パスが 250 文字より長い場合は切り捨てられます。

タイプ: 文字列

RecordIndex

オプション

データを含むレコードのレコードインデックス (0 から始まる)。

タイプ: 整数

AwsApiGatewayRestApi

-AwsApiGatewayRestApiオブジェクトには、Amazon API Gateway のバージョン 1 の REST API に関する情報が含まれています。

AwsApiGatewayRestApi: { "Id": "exampleapi", "Name": "Security Hub", "Description": "AWS Security Hub", "CreatedDate": "2018-11-18T10:20:05-08:00", "Version": "2018-10-26", "BinaryMediaTypes" : ["-'*~1*'"], "MinimumCompressionSize": 1024, "ApiKeySource": "AWS_ACCOUNT_ID", "EndpointConfiguration": { "Types": [ "REGIONAL" ] } }

AwsApiGatewayRestApi には、以下の属性を含めることができます。

ApiKeySource

オプション

使用量プランに沿ってリクエストを計測するための API キーのソース。

HEADERリクエストの X-API key ヘッダーから API キーを読み込むかどうかを指定します。

AUTHORIZERAPI キーを読み込むかどうかを示します。UsageIdentifierKeyカスタムオーソライザーから。

タイプ: 文字列

有効な値: HEADER | AUTHORIZER

BinaryMediaTypes

オプション

REST API でサポートされているバイナリメディアタイプのリスト。

タイプ: 文字列の配列

CreatedDate

オプション

API が作成された日時を示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

例:

"CreatedDate": "2017-03-22T13:22:13.933Z"
Description

オプション

REST API の説明。

タイプ: 文字列

EndpointConfiguration

オプション

REST API のエンドポイント設定。

タイプ: オブジェクト

Id

オプション

REST API の識別子。

タイプ: 文字列

MinimumCompressionSize

オプション

圧縮が有効になるまでのペイロードの最小サイズ(バイト単位)。

もしnullに設定されている場合、圧縮は無効です。

0 の場合、すべてのペイロードが圧縮されます。

タイプ: 数値

最小値はです。 0

値の最大長 10.485,760

Name

オプション

REST API の名前。

タイプ: 文字列

Version

オプション

REST API のバージョン ID です。

タイプ: 文字列

EndpointConfiguration

-EndPointConfigurationオブジェクトには、API のエンドポイントに関する情報が含まれています。

EndPointConfiguration には、以下の属性を含めることができます。

Types

オプション

REST API のエンドポイントタイプのリスト。

エッジ最適化 API の場合、エンドポイントタイプはです。EDGE。リージョナル API の場合、エンドポイントの種類はREGIONAL。プライベート API の場合、エンドポイントタイプはPRIVATE

タイプ: 文字列の配列

有効な値: EDGE | REGIONAL | PRIVATE

AwsApiGatewayStage

-AwsApiGatewayStageオブジェクトは、バージョン 1 Amazon API Gateway ステージに関する情報を提供します。

"AwsApiGatewayStage": { "DeploymentId": "n7hlmf", "ClientCertificateId": "a1b2c3", "StageName": "Prod", "Description" : "Stage Description", "CacheClusterEnabled": false, "CacheClusterSize" : "1.6", "CacheClusterStatus": "NOT_AVAILABLE", "MethodSettings": [ { "MetricsEnabled": true, "LoggingLevel": "INFO", "DataTraceEnabled": false, "ThrottlingBurstLimit": 100, "ThrottlingRateLimit": 5.0, "CachingEnabled": false, "CacheTtlInSeconds": 300, "CacheDataEncrypted": false, "RequireAuthorizationForCacheControl": true, "UnauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER", "HttpMethod": "POST", "ResourcePath": "/echo" } ], "Variables": {"test": "value"}, "DocumentationVersion": "2.0", "AccessLogSettings": { "Format": "{\"requestId\": \"$context.requestId\", \"extendedRequestId\": \"$context.extendedRequestId\", \"ownerAccountId\": \"$context.accountId\", \"requestAccountId\": \"$context.identity.accountId\", \"callerPrincipal\": \"$context.identity.caller\", \"httpMethod\": \"$context.httpMethod\", \"resourcePath\": \"$context.resourcePath\", \"status\": \"$context.status\", \"requestTime\": \"$context.requestTime\", \"responseLatencyMs\": \"$context.responseLatency\", \"errorMessage\": \"$context.error.message\", \"errorResponseType\": \"$context.error.responseType\", \"apiId\": \"$context.apiId\", \"awsEndpointRequestId\": \"$context.awsEndpointRequestId\", \"domainName\": \"$context.domainName\", \"stage\": \"$context.stage\", \"xrayTraceId\": \"$context.xrayTraceId\", \"sourceIp\": \"$context.identity.sourceIp\", \"user\": \"$context.identity.user\", \"userAgent\": \"$context.identity.userAgent\", \"userArn\": \"$context.identity.userArn\", \"integrationLatency\": \"$context.integrationLatency\", \"integrationStatus\": \"$context.integrationStatus\", \"authorizerIntegrationLatency\": \"$context.authorizer.integrationLatency\" }", "DestinationArn": "arn:aws:logs:us-west-2:111122223333:log-group:SecurityHubAPIAccessLog/Prod" }, "CanarySettings": { "PercentTraffic": 0.0, "DeploymentId": "ul73s8", "StageVariableOverrides" : [ "String" : "String" ], "UseStageCache": false }, "TracingEnabled": false, "CreatedDate": "2018-07-11T10:55:18-07:00", "LastUpdatedDate": "2020-08-26T11:51:04-07:00", "WebAclArn" : "arn:aws:waf-regional:us-west-2:111122223333:webacl/cb606bd8-5b0b-4f0b-830a-dd304e48a822" }

AwsApiGatewayStage には、以下の属性を含めることができます。

AccessLogSettings

オプション

ステージのアクセスを記録するための設定。

タイプ: オブジェクト

CacheClusterEnabled

オプション

ステージでキャッシュクラスターが有効かどうかを示します。

タイプ: ブール値

CacheClusterSize

オプション

キャッシュクラスターが有効になっている場合、キャッシュクラスターのサイズ。

タイプ: 文字列

CacheClusterStatus

オプション

キャッシュクラスターが有効な場合、キャッシュクラスターのステータス。

タイプ: 文字列

CanarySettings

オプション

ステージでのカナリアデプロイメントの設定に関する情報。

タイプ: オブジェクト

ClientCertificateId

オプション

ステージのクライアント証明書の識別子。

タイプ: 文字列

CreatedDate

オプション

ステージが作成された日時を示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"CreatedDate": "2017-03-22T13:22:13.933Z"
DeploymentId

オプション

ステージが指すデプロイメントの ID。

タイプ: 文字列

Description

オプション

ステージの説明。

タイプ: 文字列

DocumentationVersion

オプション

ステージに関連付けられている API ドキュメントのバージョン。

タイプ: 文字列

LastUpdatedDate

オプション

ステージが最後に更新された日時を示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"LastUpdatedDate": "2017-03-22T13:22:13.933Z"
MethodSettings

オプション

ステージのメソッド設定を定義します。

各メソッドについて、キーはメソッドパスで、次のように定義されます。

  • 個々のメソッドオーバーライドの場合、キーは<resource_path>/<http_method>。たとえば、accounts/DELETE と指定します。

  • ステージ内のすべてのメソッドをオーバーライドするには、キーは/*/*

タイプ: オブジェクトの配列

StageName

オプション

ステージの名前。

タイプ: 文字列

TracingEnabled

オプション

AWS X-Ray を使用したアクティブなトレーシングをこのステージで有効にするかどうかを示します。

タイプ: ブール値

Variables

オプション

ステージ変数を定義するマップです。

変数名には、次の文字を使用できます。A~Z、A~z、0~9、0~9、下線 (下線) です。

変数値には、次の文字を含めることができます。

  • 大文字と小文字

  • 数字

  • 特殊文字。_ ~:/? # & =,-(ハイフン)

タイプ: 文字列のマップ

WebAclArn

オプション

ステージに関連付けられたウェブ ACL の ARN。

タイプ: 文字列

AccessLogSettings

-AccessLogSettingsオブジェクトには、ステージのログアクセスの設定に関する情報が含まれています。

AccessLogSettings には、以下の属性を含めることができます。

DestinationArn

オプション

アクセスログを受け取る CloudWatch Logs ロググループまたは Kinesis Data Firehose 配信ストリームの ARN。

Kinesis Data Firehose 配信ストリームの場合、ストリーム名は常にamazon-apigateway-

タイプ: 文字列

Format

オプション

選択されたによって指定された、データのアクセスログの単一の行の形式。$context変数. 形式には $context.requestId が含まれている必要があります。

タイプ: 文字列

CanarySettings

-CanarySettingsオブジェクトには、ステージ内のカナリアデプロイメントの設定に関する情報が含まれています。

CanarySettings には、以下の属性を含めることができます。

DeploymentId

オプション

Canary デプロイのデプロイ識別子。

タイプ: 文字列

PercentTraffic

オプション

Canary デプロイに転送されたトラフィックの割合。

タイプ: 数値

最小値はです。 0

値の最大長 100

StageVariableOverrides

オプション

カナリアリリースデプロイメントでオーバーライドされるステージ変数。変数には、カナリアで導入された新しいステージ変数が含まれます。

各変数は、ステージ変数名と変数値の間の文字列間マップとして表されます。

"variableName" : "variableValue"

タイプ: オブジェクト

UseStageCache

オプション

Canary デプロイで、ステージキャッシュを使用するかどうかを指定します。

タイプ: ブール値

MethodSettings

-MethodSettingsオブジェクトは、ステージのメソッド設定を定義します。

各メソッドオブジェクトMethodSettingsには、以下の属性を含めることができます。

CacheDataEncrypted

オプション

キャッシュされたレスポンスが暗号化されているかどうかを示します。

タイプ: ブール値

CachingEnabled

オプション

リクエストに対してレスポンスがキャッシュされ返されるかどうかを示します。応答をキャッシュするには、ステージでキャッシュクラスターを有効にする必要があります。

タイプ: ブール値

CacheTtlInSeconds

オプション

キャッシュされた応答の有効期限 (TTL) を秒単位で指定します。TTL が大きいほど、応答がキャッシュされる時間が長くなります。

タイプ: 数値

DataTraceEnabled

オプション

メソッドでデータトレースロギングが有効かどうかを示します。データトレースロギングは、CloudWatch Logs にプッシュされるログエントリに影響します。

タイプ: ブール値

HttpMethod

オプション

HTTP メソッド。複数のメソッドにメソッドの設定を適用するために、アスタリスク (*) をワイルドカードとして使用できます。

タイプ: 文字列

LoggingLevel

オプション

このメソッドのログレベル。ログレベルは、CloudWatch Logs にプッシュされるログエントリに影響します。

ログ記録のレベルがERRORに設定されている場合、ログにはエラーレベルのエントリのみが含まれます。

ログ記録のレベルがINFOの場合、ログにはERRORイベントと追加情報イベント。

タイプ: 文字列

有効な値: OFF | ERROR | INFO

MetricsEnabled

オプション

メソッドで CloudWatch メトリクスが有効かどうかを示します。

タイプ: ブール値

RequireAuthorizationForCacheControl

オプション

キャッシュ無効化要求に認可が必要かどうかを示します。

タイプ: ブール値

ResourcePath

オプション

このメソッドのリソースのパス。スラッシュ (/) は ~1 としてエンコードされます。最初のスラッシュには、スラッシュを含める必要があります。

たとえば、パス値 /resource/subresource/~1resource~1subresource としてエンコードされる必要があります。

ルートパスを指定するには、スラッシュのみ (/) を使用します。複数のメソッドにメソッドの設定を適用するために、アスタリスク (*) をワイルドカードとして使用できます。

タイプ: 文字列

ThrottlingBurstLimit

オプション

メソッドのスロットリングバースト制限。

タイプ: 番号 (インスタンスnteger)

ThrottlingRateLimit

オプション

メソッドのスロットリングレート制限。

タイプ: 数値

UnauthorizedCacheControlHeaderStrategy

オプション

キャッシュ無効化のための不正な要求を処理する方法を示します。

タイプ: 文字列

有効な値: FAIL_WITH_403 | SUCCEED_WITH_RESPONSE_HEADER | SUCCEED_WITHOUT_RESPONSE_HEADER

AwsApiGatewayV2Api

-AwsApiGatewayV2Apiオブジェクトには、Amazon API Gateway のバージョン 2 API に関する情報が含まれています。

"AwsApiGatewayV2Api": { "ApiEndpoint": "https://example.us-west-2.amazonaws.com", "ApiId": "a1b2c3d4", "ApiKeySelectionExpression": "$request.header.x-api-key", "CreatedDate": "2020-03-28T00:32:37Z", "Description": "ApiGatewayV2 Api", "Version": "string", "Name": "my-api", "ProtocolType": "HTTP", "RouteSelectionExpression": "$request.method $request.path", "CorsConfiguration": { "AllowOrigins": [ "*" ], "AllowCredentials": true, "ExposeHeaders": [ "string" ], "MaxAge": 3000, "AllowMethods": [ "GET", "PUT", "POST", "DELETE", "HEAD" ], "AllowHeaders": [ "*" ] } }

AwsApiGatewayV2Api には、以下の属性を含めることができます。

ApiEndpoint

オプション

API の URI。

タイプ: 文字列

形式: <api-id>.execute-api.<region>.amazonaws.com

通常、ステージ名は URI に追加され、デプロイされた API ステージへの完全パスを形成します。

ApiId

オプション

API の識別子。

タイプ: 文字列

ApiKeySelectionExpression

オプション

API キー選択式 WebSocket API 呼び出しでのみサポートされています。

タイプ: 文字列

CorsConfiguration

オプション

Origin Resource Sharing (CORS) の設定。HTTP API 呼び出しでのみサポートされています。

タイプ: オブジェクト

CreatedDate

オプション

API が作成された日時を示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"CreatedDate": "2017-03-22T13:22:13.933Z"
Description

オプション

API の説明。

タイプ: 文字列

Name

オプション

API の名前。

タイプ: 文字列

ProtocolType

オプション

API の API プロトコル。

タイプ: 文字列

有効な値: WEBSOCKET | HTTP

RouteSelectionExpression

オプション

API のルート選択式です。

HTTP API 呼び出しの場合は、${request.method} ${request.path}。これは HTTP API 呼び出しのデフォルト値です。

WebSocket API 呼び出しの場合、デフォルト値はありません。

タイプ: 文字列

Version

オプション

API のバージョン ID。

タイプ: 文字列

CorsConfiguration

-CorsConfigurationオブジェクトには、API のクロスオリジンリソース共有 (CORS) 設定が含まれます。CORS は HTTP API 呼び出しに対してのみサポートされます。

CorsConfiguration には、以下の属性を含めることができます。

AllowCredentials

オプション

CORS 要求に認証情報が含まれているかどうかを示します。

タイプ: ブール値

AllowHeaders

オプション

CORS 要求に許可されるヘッダー。

タイプ: 文字列の配列

AllowMethods

オプション

CORS 要求に許可されるメソッド。

タイプ: 文字列の配列

AllowOrigins

オプション

CORS リクエストの許可されたオリジン。

タイプ: 文字列の配列

ExposeHeaders

オプション

CORS リクエストの公開ヘッダー。

タイプ: 文字列の配列

MaxAge

オプション

ブラウザがプリフライトリクエスト結果をキャッシュする秒数。

タイプ: 数値

AwsApiGatewayV2Stage

AwsApiGatewayV2StageAmazon API Gateway のバージョン 2 ステージに関する情報が含まれます。

"AwsApiGatewayV2Stage": { "CreatedDate": "2020-04-08T00:36:05Z", "Description" : "ApiGatewayV2", "DefaultRouteSettings": { "DetailedMetricsEnabled": false, "LoggingLevel": "INFO", "DataTraceEnabled": true, "ThrottlingBurstLimit": 100, "ThrottlingRateLimit": 50 }, "DeploymentId": "x1zwyv", "LastUpdatedDate": "2020-04-08T00:36:13Z", "RouteSettings": { "DetailedMetricsEnabled": false, "LoggingLevel": "INFO", "DataTraceEnabled": true, "ThrottlingBurstLimit": 100, "ThrottlingRateLimit": 50 }, "StageName": "prod", "StageVariables": [ "function": "my-prod-function" ], "AccessLogSettings": { "Format": "{\"requestId\": \"$context.requestId\", \"extendedRequestId\": \"$context.extendedRequestId\", \"ownerAccountId\": \"$context.accountId\", \"requestAccountId\": \"$context.identity.accountId\", \"callerPrincipal\": \"$context.identity.caller\", \"httpMethod\": \"$context.httpMethod\", \"resourcePath\": \"$context.resourcePath\", \"status\": \"$context.status\", \"requestTime\": \"$context.requestTime\", \"responseLatencyMs\": \"$context.responseLatency\", \"errorMessage\": \"$context.error.message\", \"errorResponseType\": \"$context.error.responseType\", \"apiId\": \"$context.apiId\", \"awsEndpointRequestId\": \"$context.awsEndpointRequestId\", \"domainName\": \"$context.domainName\", \"stage\": \"$context.stage\", \"xrayTraceId\": \"$context.xrayTraceId\", \"sourceIp\": \"$context.identity.sourceIp\", \"user\": \"$context.identity.user\", \"userAgent\": \"$context.identity.userAgent\", \"userArn\": \"$context.identity.userArn\", \"integrationLatency\": \"$context.integrationLatency\", \"integrationStatus\": \"$context.integrationStatus\", \"authorizerIntegrationLatency\": \"$context.authorizer.integrationLatency\" }", "DestinationArn": "arn:aws:logs:us-west-2:111122223333:log-group:SecurityHubAPIAccessLog/Prod" }, "AutoDeploy": false, "LastDeploymentStatusMessage": "Message", "ApiGatewayManaged": true, }

AwsApiGatewayV2Stage には、以下の属性を含めることができます。

AccessLogSettings

オプション

ステージのアクセスを記録するための設定に関する情報。

タイプ: オブジェクト

ApiGatewayManaged

オプション

ステージが API Gateway によって管理されているかどうかを示します。

タイプ: ブール値

AutoDeploy

オプション

API の更新によって新しいデプロイが自動的にトリガーされるかどうかを指定します。

タイプ: ブール値

CreatedDate

オプション

ステージが作成された日時を示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"CreatedDate": "2017-03-22T13:22:13.933Z"
DefaultRouteSettings

オプション

ステージのデフォルトルート設定。

タイプ: オブジェクト

DeploymentId

オプション

ステージが関連付けられるデプロイメントの ID。

タイプ: 文字列

Description

オプション

ステージの説明。

タイプ: 文字列

LastDeploymentStatusMessage

オプション

ステージの最終デプロイのステータス。ステージで自動デプロイが有効になっている場合にのみサポートされます。

タイプ: 文字列

LastUpdatedDate

オプション

ステージが最後に更新された日時を示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"LastUpdatedDate": "2017-03-22T13:22:13.933Z"
RouteSettings

オプション

ステージのルート設定です。

タイプ: オブジェクト

StageName

オプション

ステージの名前。

タイプ: 文字列

StageVariables

オプション

ステージ変数を定義するマップです。

変数名には、次の文字を使用できます。A~Z、A~z、0~9、0~9、下線 (下線) です。

タイプ: 文字列のマップ

有効な値:

  • 大文字と小文字

  • 数字

  • 特殊文字。_ ~:/? # & =,-(ハイフン)

AccessLogSettings

-AccessLogSettingsオブジェクトには、ステージのログアクセスの設定に関する情報が含まれています。

AccessLogSettings には、以下の属性を含めることができます。

DestinationArn

オプション

アクセスログを受け取る CloudWatch Logs ロググループの ARN。

タイプ: 文字列

Format

オプション

選択されたによって指定された、データのアクセスログの単一の行の形式。$context変数. 形式には $context.requestId が含まれている必要があります。

タイプ: 文字列

DefaultRouteSettings および RouteSettings

-DefaultRouteSettingsオブジェクトには、ステージのデフォルトのルート設定が含まれています。

-RouteSettingsオブジェクトには、ステージのルート設定が含まれています。

これらのオブジェクトには、次の属性を含めることができます。

DataTraceEnabled

オプション

データトレースログ記録が有効かどうかを示します。データトレースロギングは、CloudWatch Logs にプッシュされるログエントリに影響します。WebSocket API 呼び出しでのみサポートされています。

タイプ: ブール値

DetailedMetricsEnabled

オプション

詳細なメトリクスを有効にするかどうかを示します。

タイプ: ブール値

LoggingLevel

オプション

ログ記録のレベル。ログレベルは、CloudWatch Logs にプッシュされるログエントリに影響します。WebSocket API 呼び出しでのみサポートされています。

ログ記録のレベルがERRORに設定されている場合、ログにはエラーレベルのエントリのみが含まれます。

ログ記録のレベルがINFOの場合、ログにはERRORイベントと追加情報イベント。

タイプ: 文字列

有効な値: OFF | ERROR | INFO

ThrottlingBurstLimit

オプション

スロットリングのバースト制限。

タイプ: 数値

ThrottlingRateLimit

オプション

スロットリングのレート制限です。

タイプ: 数値

AwsAutoScalingAutoScalingGroup

-AwsAutoScalingAutoScalingGroupオブジェクトは、自動スケーリンググループの詳細を提供します。

"AwsAutoScalingAutoScalingGroup": { "CreatedTime": "2017-10-17T14:47:11Z", "HealthCheckGracePeriod": 300, "HealthCheckType": "EC2", "LaunchConfigurationName": "mylaunchconf", "LoadBalancerNames": [] }

AwsAutoScalingAutoScalingGroup オブジェクトには、次の属性を含めることができます。

CreatedTime

オプション

自動スケーリンググループが作成された時刻を示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

HealthCheckGracePeriod

オプション

Amazon EC2 Auto Scaling がサービス状態になった EC2 インスタンスのヘルスステータスを確認するまでに待機する時間 (秒単位)。

タイプ: 整数

HealthCheckType

オプション

ヘルスチェックに使用するサービス。

タイプ: 文字列

最大長: 32

有効な値: EC2 | ELB

LaunchConfigurationName

オプション

起動設定の名前。

タイプ: 文字列

最大長: 32

LoadBalancerNames

オプション

グループに関連付けられたロードバランサーのリスト。

タイプ: 文字列の配列

文字列あたりの最大長:255 文字

AwsCertificateManagerCertificate

-AwsCertificateManagerCertificateオブジェクトは、AWS Certificate Manager 証明書 (ACM) の詳細を提供します。

"AwsCertificateManagerCertificate": { "CertificateAuthorityArn": "arn:aws:acm:us-west-2:444455556666:certificate-authority/example", "CreatedAt": "2019-05-24T18:12:02.000Z", "DomainName": "example.amazondomains.com", "DomainValidationOptions": [ { "DomainName": "example.amazondomains.com", "ResourceRecord": { "Name": "_1bacb61828d3a1020c40a560ceed08f7.example.amazondomains.com", "Type": "CNAME", "Value": "_example.acm-validations.aws." }, "ValidationDomain": "example.amazondomains.com"", "ValidationEmails": [], "ValidationMethod": "DNS", "ValidationStatus": "SUCCESS" } ], "ExtendedKeyUsages": [ { "Name": "TLS_WEB_SERVER_AUTHENTICATION", "OId": "1.3.6.1.5.5.7.3.1" }, { "Name": "TLS_WEB_CLIENT_AUTHENTICATION", "OId": "1.3.6.1.5.5.7.3.2" } ], "FailureReason": "", "ImportedAt": "2018-08-17T00:13:00.000Z", "InUseBy": ["arn:aws:amazondomains:us-west-2:444455556666:loadbalancer/example"], "IssuedAt": "2020-04-26T00:41:17.000Z", "Issuer": "Amazon", "KeyAlgorithm": "RSA-1024", "KeyUsages": [ { "Name": "DIGITAL_SIGNATURE", }, { "Name": "KEY_ENCIPHERMENT", } ], "NotAfter": "2021-05-26T12:00:00.000Z", "NotBefore": "2020-04-26T00:00:00.000Z", "Options": { "CertificateTransparencyLoggingPreference": "ENABLED", } "RenewalEligibility": "ELIGIBLE", "RenewalSummary": { "DomainValidationOptions": [ { "DomainName": "example.amazondomains.com", "ResourceRecord": { "Name": "_1bacb61828d3a1020c40a560ceed08f7.example.amazondomains.com", "Type": "CNAME", "Value": "_example.acm-validations.aws.com", }, "ValidationDomain": "example.amazondomains.com", "ValidationEmails": [], "ValidationMethod": "DNS", "ValidationStatus": "SUCCESS" } ], "RenewalStatus": "SUCCESS", "RenewalStatusReason": "", "UpdatedAt": "2020-04-26T00:41:35.000Z", }, "Serial": "02:ac:86:b6:07:2f:0a:61:0e:3a:ac:fd:d9:ab:17:1a", "SignatureAlgorithm": "SHA256WITHRSA", "Status": "ISSUED", "Subject": "CN=example.amazondomains.com"", "SubjectAlternativeNames": ["example.amazondomains.com"], "Type": "AMAZON_ISSUED" }

AwsCertificateManagerCertificate には、以下の属性を含めることができます。

CertificateAuthorityArn

オプション

証明書の発行に使用するプライベート認証機関 (CA) の ARN。

タイプ: 文字列

CreatedAt

オプション

証明書がいつ要求されたかを示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"CreatedAt": "2017-03-22T13:22:13.933Z"
DomainName

オプション

証明書で保護される www.example.com などの完全修飾ドメイン名 (FQDN)。

タイプ: 文字列

最小長: 1

最大長: 253

DomainValidationOptions

オプション

結果として発生する各ドメイン名の初期検証に関する情報が含まれています、RequestCertificateリクエスト.

証明書の種類がAMAZON_ISSUED

タイプ: オブジェクトの配列

ExtendedKeyUsages

オプション

拡張キー使用法 X.509 v3 拡張オブジェクトのリストが含まれます。各オブジェクトは、証明書の公開キーを使用できる目的を指定し、名前とオブジェクト識別子 (OID) で構成されます。

タイプ: オブジェクトの配列

FailureReason

オプション

失敗した証明書要求の場合、エラーの理由。

タイプ: 文字列

有効な値: NO_AVAILABLE_CONTACTS|ADDITIONAL_VERIFICATION_REQUIRED|DOMAIN_NOT_ALLOWED|INVALID_PUBLIC_DOMAIN|DOMAIN_VALIDATION_DENIED|CAA_ERROR|PCA_LIMIT_EXCEEDED|PCA_INVALID_ARN|PCA_INVALID_STATE|PCA_REQUEST_FAILED|PCA_NAME_CONSTRAINTS_VALIDATION|PCA_RESOURCE_NOT_FOUND|PCA_INVALID_ARGS|PCA_INVALID_DURATION|PCA_ACCESS_DENIED|SLR_NOT_FOUND|OTHER

ImportedAt

オプション

証明書がいつインポートされたかを示します。証明書タイプがIMPORTED

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"ImportedAt": "2017-03-22T13:22:13.933Z"
InUseBy

オプション

証明書を使用する AWS リソースの ARN のリスト。

タイプ: 文字列の配列

IssuedAt

オプション

証明書が発行された時刻を示します。証明書タイプがAMAZON_ISSUED

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"IssuedAt": "2017-03-22T13:22:13.933Z"
Issuer

オプション

証明書を発行して署名した認証局の名前。

タイプ: 文字列

KeyAlgorithm

オプション

パブリックキーとプライベートキーのペアを生成するために使用されたアルゴリズム。

タイプ: 文字列

有効な値: RSA_2048|RSA_1024| RSA_4096|EC_prime256v1|EC_secp384r1|EC_secp521r1

KeyUsages

オプション

キー使用法 X.509 v3 拡張オブジェクトのリスト。

タイプ: オブジェクトの配列

NotAfter

オプション

証明書が無効になった時間。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"NotAfter": "2017-03-22T13:22:13.933Z"
NotBefore

オプション

証明書が有効でないまでの時間。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"NotBefore": "2017-03-22T13:22:13.933Z"
Options

オプション

証明書を透過性ログに追加するかどうかを指定する値を指定します。

タイプ: オブジェクト

RenewalEligibility

オプション

証明書が更新の対象かどうか。

タイプ: 文字列

有効な値: ELIGIBLE | INELIGIBLE

RenewalSummary

オプション

証明書の ACM 管理更新の状態に関する情報。証明書の種類がAMAZON_ISSUED

タイプ: オブジェクト

Serial

オプション

証明書のシリアル番号。

タイプ: 文字列

SignatureAlgorithm

オプション

証明書の署名に使用されたアルゴリズムです。

タイプ: 文字列

Status

オプション

証明書のステータス。

タイプ: 文字列

有効な値: PENDING_VALIDATION|ISSUED|INACTIVE|EXPIRED|VALIDATION_TIMED_OUT|REVOKED|FAILED

Subject

オプション

証明書に含まれる公開キーに関連付けられているエンティティの名前。

タイプ: 文字列

SubjectAlternativeNames

オプション

証明書に含まれる 1 つまたは複数のドメイン名 (サブジェクトの別名)。このリストには、証明書に含まれているパブリックキーにバインドされているドメイン名が含まれています。

サブジェクトの代替名には、証明書の正規ドメイン名 (CN) と、Web サイトへの接続に使用できる追加のドメイン名が含まれます。

タイプ: 文字列の配列

最小項目数はです。 1

最大項目数はです。 100

商品ごとの最小長さ: 1

商品ごとの最大長: 253

Type

オプション

証明書のソース。ACM が提供する証明書については、TypeAMAZON_ISSUED。でインポートされた証明書の場合ImportCertificate,TypeIMPORTED

タイプ: 文字列

有効な値: IMPORTED | AMAZON_ISSUED | PRIVATE

DomainValidationOptions

-DomainValidationOptionsオブジェクトには、次のいずれかの情報が含まれています。

  • 結果として発生する各ドメイン名の初期検証RequestCertificateリクエスト

  • 証明書の各ドメイン名の検証 (ACM マネージド更新に関連する)

DomainValidationOptions には、以下の属性を含めることができます。

DomainName

オプション

証明書内の完全修飾ドメイン名 (FQDN)。

タイプ: 文字列

ResourceRecord

オプション

ドメイン検証のために DNS データベースに追加される CNAME レコード。

タイプ: オブジェクト

ValidationDomain

オプション

ACM がドメイン検証メールの送信に使用するドメイン名。

タイプ: 文字列

ValidationEmails

オプション

ACM がドメイン検証メールの送信に使用する電子メールアドレスのリスト。

タイプ: 文字列の配列

ValidationMethod

オプション

ドメイン名を検証するために使用されるメソッド。

タイプ: 文字列

ValidationStatus

オプション

ドメイン名の検証ステータス。

タイプ: 文字列

ResourceRecordリソースに関する次の詳細が示されます。

Name

オプション

リソースの名前。

タイプ: 文字列

Type

オプション

リソースのタイプ。

タイプ: 文字列

Value

オプション

リソースの値。

タイプ: 文字列

ExtendedKeyUsages

ExtendedKeyUsagesには、拡張キー使用法 X.509 v3 拡張オブジェクトのリストが含まれています。

各拡張オブジェクトには、次の属性を含めることができます。

Name

オプション

拡張子の値の名前。証明書の公開キーを使用できる目的を示します。

タイプ: 文字列

Oid

オプション

拡張値のオブジェクト識別子 (OID)。

タイプ: 文字列

形式: ピリオドで区切られた数字

"OId": "1.3.6.1.5.5.7.3.1"

KeyUsages

-KeyUsagesオブジェクトには、キー使用法 X.509 v3 拡張オブジェクトのリストが含まれます。

各拡張オブジェクトには、次の属性を含めることができます。

Name

オプション

キー使用法の拡張名。

タイプ: 文字列

Options

-Optionsオブジェクトには、証明書のその他のオプションが含まれています。

現在、唯一のオプションは、証明書を透過性ログに追加するかどうかを示します。

Options には、以下の属性を含めることができます。

CertificateTransparencyLoggingPreference

オプション

証明書を透過性ログに追加するかどうか。

タイプ: 文字列

有効な値: DISABLED | ENABLED

RenewalSummary

-RenewalSummaryオブジェクトには、ACM 管理更新に関する情報が含まれています。AMAZON_ISSUED証明書。

RenewalSummary には、以下の属性を含めることができます。

DomainValidationOptions

オプション

ACM 管理更新に関連する証明書内の各ドメイン名の検証に関する情報。証明書の種類がAMAZON_ISSUED

タイプ: オブジェクトの配列

RenewalStatus

オプション

証明書の ACM 管理更新のステータス。

タイプ: 文字列

有効な値: PENDING_AUTO_RENEWAL|PENDING_VALIDATION|SUCCESS|FAILED

RenewalStatusReason

オプション

更新要求が失敗した理由。

タイプ: 文字列

有効な値: NO_AVAILABLE_CONTACTS|ADDITIONAL_VERIFICATION_REQUIRED|DOMAIN_NOT_ALLOWED|INVALID_PUBLIC_DOMAIN|DOMAIN_VALIDATION_DENIED|CAA_ERROR|PCA_LIMIT_EXCEEDED|PCA_INVALID_ARN|PCA_INVALID_STATE|PCA_REQUEST_FAILED|PCA_NAME_CONSTRAINTS_VALIDATION|PCA_RESOURCE_NOT_FOUND|PCA_INVALID_ARGS|PCA_INVALID_DURATION|PCA_ACCESS_DENIED|SLR_NOT_FOUND|OTHER

UpdatedAt

オプション

更新の概要が最後に更新された日を示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"UpdatedAt": "2017-03-22T13:22:13.933Z"

AwsCloudFrontDistribution

AwsCloudFrontDistribution オブジェクトは、ディストリビューション設定の詳細を提供します。

これには、次の属性を含めることができます。

CacheBehaviors

オプション

ディストリビューションのキャッシュ構成に関する情報を提供します。

タイプ: オブジェクト

DefaultCacheBehavior

オプション

設定のデフォルトのキャッシュ動作。

タイプ: オブジェクト

DefaultRootObject

オプション

ビューワーがディストリビューション内のオブジェクトではなくディストリビューションのルート URL をリクエストするときに、CloudFront がリクエストする、オリジンからのオブジェクト。たとえば、index.html からのリクエストに応じて、ビューアは http://www.example.com/product-description.html ではなく http://www.example.com を要求します。

タイプ: 文字列

DomainName

オプション

ディストリビューションに対応するドメイン名。

タイプ: 文字列

Etag

オプション

エンティティタグは、オブジェクトのハッシュです。

タイプ: 文字列

LastModifiedTime

オプション

ディストリビューションが最後に変更された日を示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

Logging

オプション

ディストリビューションのアクセスログを記録するかどうかを制御する複合型。

タイプ: オブジェクト

OriginGroups

オプション

ディストリビューション内のオリジングループに関する情報を提供します。

タイプ: オブジェクト

Origins

オプション

このディストリビューションのオリジンとオリジングループに関する情報を含む複合型。

タイプ: 文字列

Status

オプション

ディストリビューションの現在のステータスを示します。

タイプ: 文字列

WebAclId

オプション

このディストリビューションに関連付ける AWS WAF ウェブ ACL がある場合は、それを指定する一意の識別子。

タイプ: 文字列

CacheBehaviors

-CacheBehaviorsオブジェクトは、ディストリビューションのキャッシュに関する情報を提供します。-CacheBehaviorsオブジェクトには、Itemsオブジェクトの配列。-Itemsオブジェクトはキャッシュ動作を表します。

の各オブジェクトItemsには、以下の属性を含めることができます。

ViewerProtocolPolicy

オプション

ビューワーがオリジンにあるファイルにアクセスするために使用できるプロトコル。以下のオプションを指定できます。

  • allow-all— ビューワーは HTTP または HTTPS を使用できます。

  • redirect-to-https— CloudFront は HTTP ステータスコード 301 (永続的に移動) および HTTPS URL を使用して HTTP リクエストに応答します。その後、ビューアは新しい URL を使用して再送信します。

  • https-only— CloudFront は HTTP リクエストに HTTP ステータスコード 403 (禁止) で応答します。

タイプ: 文字列

有効な値: allow-all | https-only | redirect-to-https

DefaultCacheBehavior

-DefaultCacheBehaviorオブジェクトには、ディストリビューションのデフォルトのキャッシュ設定に関する情報が含まれています。

DefaultCacheBehavior には、以下の属性を含めることができます。

ViewerProtocolPolicy

オプション

ビューワーがオリジンにあるファイルにアクセスするために使用できるプロトコル。以下のオプションを指定できます。

  • allow-all— ビューワーは HTTP または HTTPS を使用できます。

  • redirect-to-https— CloudFront は HTTP ステータスコード 301 (永続的に移動) および HTTPS URL を使用して HTTP リクエストに応答します。その後、ビューアは新しい URL を使用して再送信します。

  • https-only— CloudFront は HTTP リクエストに HTTP ステータスコード 403 (禁止) で応答します。

タイプ: 文字列

有効な値: allow-all | https-only | redirect-to-https

Logging

Logging オブジェクトは、ディストリビューションのログ記録に関する情報を提供します。

これには、次の属性を含めることができます。

Bucket

オプション

アクセスログを保存する S3 バケット。

タイプ: 文字列

Enabled

オプション

このフィールドでは、選択したディストリビューションを有効または無効にすることができます。

タイプ: ブール値

IncludeCookies

オプション

CloudFront がアクセスログに Cookie を含めるかどうかを指定します。

タイプ: ブール値

Prefix

オプション

CloudFront でこのディストリビューションのアクセスログファイル名にプレフィックスとして使用するオプションの文字列。

タイプ: 文字列

OriginGroups

-OriginGroupsオブジェクトには、ディストリビューションのオリジングループに関する情報が含まれています。

構造は以下のとおりです。

"OriginGroups": { "Items": [ { "FailoverCriteria": { "StatusCodes": { "Items": [ number ], "Quantity": number } } } ] },

OriginGroupsにはItemsオブジェクトの配列。各オブジェクトは、オリジングループを表します。

Items オブジェクトには FailoverCriteria オブジェクトが含まれます。-FailoverCriteriaオブジェクトは、オリジングループがフェイルオーバーするタイミングに関する情報を提供します。

-FailoverCriteriaオブジェクトにはが含まれます。StatusCodesオブジェクト。StatusCodesに、フェールオーバーの原因となるステータスコードを示します。

Items

オプション

次のオリジンへのフェールオーバーを引き起こす可能性のあるステータスコード値のリスト。

タイプ: 数値の配列。

Quantity

オプション

フェイルオーバーを引き起こす可能性のあるステータスコードの数。

タイプ: 数値

Origins

このディストリビューションのオリジンとオリジングループに関する情報を含む Origins オブジェクト。

これには、次の属性を含めることができます。

Items

オプション

このディストリビューションのオリジンまたはオリジングループを含む複合型。

タイプ: オブジェクトの配列

各項目には、次の属性を含めることができます。

DomainName

オプション

Amazon S3 オリジン: CloudFront がこのオリジンのオブジェクトを取得する元の S3 バケットの DNS 名。

タイプ: 文字列

Id

オプション

オリジンまたはオリジングループの一意の識別子。

タイプ: 文字列

OriginPath

オプション

CloudFront が S3 バケットまたはカスタムオリジンのディレクトリにコンテンツをリクエストするように指示するオプションの要素。

タイプ: 文字列

S3OriginConfig

オプション

静的ウェブサイトホスティングで設定されていない S3 バケットであるオリジン。

タイプ: オブジェクト

S3OriginConfig には、以下の属性を含めることができます。

OriginAccessIdentity

オプション

オリジンに関連付ける CloudFront オリジンアクセスアイデンティティ。

タイプ: 文字列

AwsCloudTrailTrail

-AwsCloudTrailTrailオブジェクトは、CloudTrail トレイルに関する詳細を提供します。

"AwsCloudTrailTrail": { "CloudWatchLogsLogGroupArn": "arn:aws:logs:us-west-2:123456789012:log-group:CloudTrail/regression:*", "CloudWatchLogsRoleArn": "arn:aws:iam::866482105055:role/CloudTrail_CloudWatchLogs", "HasCustomEventSelectors": true, "HomeRegion": "us-west-2", "IncludeGlobalServiceEvents": true, "IsMultiRegionTrail": true, "IsOrganizationTrail": false, "KmsKeyId": "kmsKeyId", "LogFileValidationEnabled": true, "Name": "regression-trail", "S3BucketName": "cloudtrail-bucket", "S3KeyPrefix": "s3KeyPrefix", "SnsTopicArn": "arn:aws:sns:us-east-2:123456789012:MyTopic", "SnsTopicName": "snsTopicName", "TrailArn": "arn:aws:cloudtrail:us-west-2:123456789012:trail" }

AwsCloudTrailTrail には、以下の属性を含めることができます。

CloudWatchLogsLogGroupArn

オプション

CloudTrail がログに記録する先のロググループの ARN。

タイプ: 文字列

CloudWatchLogsRoleArn

オプション

CloudWatch Logs エンドポイントがロググループに書き込むときに引き受けるロールの ARN。

タイプ: 文字列

HasCustomEventSelectors

オプション

トレイルにカスタムイベントセレクタがあるかどうかを示します。

タイプ: ブール値

HomeRegion

オプション

証跡が作成されたリージョン。

タイプ: 文字列

IncludeGlobalServiceEvents

オプション

グローバルサービス (IAM など) からのイベントをログファイルに発行するかどうかを示します。

タイプ: ブール値

IsMultiRegionTrail

オプション

証跡を現在のリージョンのみに適用するか、すべてのリージョンに適用するかを示します。

タイプ: ブール値

IsOrganizationTrail

オプション

証跡が AWS Organizations 内の組織内のすべてのアカウントに対して作成されるか、現在の AWS アカウントに対してのみ作成されるか。

タイプ: ブール値

KmsKeyId

オプション

ログの暗号化に使用する AWS KMS キー ID。

タイプ: 文字列

LogFileValidationEnabled

オプション

CloudTrail ログファイルの検証が有効になっているかどうかを示します。

タイプ: ブール値

Name

オプション

証跡の名前。

タイプ: 文字列

S3BucketName

オプション

ログファイルが発行されている S3 バケットの名前。

タイプ: 文字列

最小長: 3

最大長: 63

S3KeyPrefix

オプション

S3 key prefix。key prefix は、ログファイルが発行されている S3 バケットの名前の後に追加されます。

タイプ: 文字列

最大長: 200

SnsTopicArn

オプション

ログファイル配信の通知に使用される SNS トピックの ARN。

タイプ: 文字列

SnsTopicName

オプション

ログファイル配信の通知に使用される SNS トピックの名前。

タイプ: 文字列

最大長: 255

TrailArn

オプション

証跡の ARN。

タイプ: 文字列

AwsCodeBuildProject

-AwsCodeBuildProjectオブジェクトは、AWS CodeBuild プロジェクトに関する情報を提供します。

"AwsCodeBuildProject": { "EncryptionKey": "my-symm-key", "Environment": { "Type": "LINUX_CONTAINER", "Certificate": "myX509", "ImagePullCredentialsType": "CODEBUILD", "RegistryCredential": { "Credential": "my_dockerhub_secret", "CredentialProvider": "SECRETS_MANAGER" } }, "Name": "my-cd-project", "Source": { "Type": "CODECOMMIT", "Location": "https://git-codecommit.us-east-2.amazonaws.com/v1/repos/MyDemoRepo", "GitCloneDepth": 1 }, "ServiceRole": "arn:aws:iam:myrole", "VpcConfig": { "VpcId": "vpc-1234456", "Subnets": ["sub-12344566"], "SecurityGroupIds": ["sg-123456789012"] } }

AwsCodeBuildProject オブジェクトには、次の属性を含めることができます。

EncryptionKey

オプション

ビルド出力アーティファクトの暗号化に使用する AWS KMS カスタマーマスターキー (CMK)。

注記

サービスロールにそのキーへのアクセス権限がある場合、クロスアカウントの KMS キーを使用してビルド出力アーティファクトを暗号化できます。

CMK の ARN または CMK エイリアス (使用可能な場合: 形式 alias/alias-name を使用) のいずれかを指定できます。

タイプ: 文字列

最小長: 1

Environment

オプション

このビルドプロジェクトのビルド環境に関する情報。

タイプ: オブジェクト

Name

オプション

ビルドプロジェクトの名前です。

タイプ: 文字列

最小長: 2

最大長: 255

パターン: [A-z0-9] [A-Za-z0---\-_] {1,254} {1,254}}

ServiceRole

オプション

CodeBuild が AWS アカウントの代わりに依存 AWS サービスとやり取りできるようにする IAM ロールの ARN。

タイプ: 文字列

最小長: 1

Source

オプション

このビルドプロジェクトのビルド入力ソースコードに関する情報。

タイプ: オブジェクト

VpcConfig

オプション

CodeBuild がアクセスする VPC 設定に関する情報。

タイプ: オブジェクト

Environment

Environment オブジェクトは、ビルドプロジェクトのビルド環境に関する情報を提供します。

これには、次の属性を含めることができます。

Certificate

オプション

このビルドプロジェクトで使用する証明書。

タイプ: 文字列

ImagePullCredentialsType

オプション

ビルドのイメージをプルするために CodeBuild で使用する認証情報のタイプ。2 つの有効な値があります。

CODEBUILDCodeBuild で独自の認証情報を使用することを指定します。これには、CodeBuild サービスプリンシパルを信頼するように ECR リポジトリポリシーを変更する必要があります。

SERVICE_ROLECodeBuild でビルドプロジェクトのサービスロールを使用することを指定します。

クロスアカウントまたはプライベートレジストリイメージを使用する場合は、SERVICE_ROLE の認証情報を使用する必要があります。CodeBuild の選別されたイメージを使用する場合は、CODEBUILD認証情報。

タイプ: 文字列

有効な値: CODEBUILD | SERVICE_ROLE

RegistryCredential

オプション

プライベートレジストリにアクセスするための認証情報。

タイプ: オブジェクト

Type

必須

関連するビルドに使用するビルド環境のタイプ。

タイプ: 文字列

有効な値: WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER

RegistryCredentials オブジェクト内の各レジストリ認証情報には、次の属性があります。

Credential

必須

AWS Secrets Manager を使用して作成された認証情報の ARN または名前。

注記

認証情報で認証情報の名前を使用できるのは、認証情報が現在の AWS リージョン内に存在する場合のみです。

タイプ: 文字列

最小長: 1

CredentialProvider

必須

プライベート Docker レジストリにアクセスするための認証情報を作成したサービス。有効な値は以下のとおりです SECRETS_MANAGER、Secrets Manager のためのものです。

タイプ: 文字列

有効な値: SECRETS_MANAGER

Source

Source オブジェクトは、このビルドプロジェクトのビルド入力ソースコードに関する情報を提供します。

これには、次の属性を含めることができます。

GitCloneDepth

オプション

ビルドプロジェクトの Git クローンの深さに関する情報。

タイプ: 整数

最小値はです。 0

Location

オプション

ビルドするソースコードの場所に関する情報。

タイプ: 文字列

有効な値:

  • AWS CodePipeline のパイプラインのソースアクションで指定されているソースコード設定の場合は、location を指定しないでください。それを指定した場合、CodePipeline によって無視されます。これは、CodePipeline がこの値ではなくパイプラインのソースアクションの設定を使用するためです。

  • AWS CodeCommit リポジトリのソースコードの場合は、ソースコードとビルド仕様ファイルを含むリポジトリの、HTTPS クローン URL (例:https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name).

  • S3 入力バケットのソースコードの場合、次のいずれかです。

    • へのパス。.zipソースコードを含むファイル (例:bucket-name/path/to/object-name.zip).

    • ソースコードを含むフォルダのパス (例: bucket-name/path/to/source-code/folder/)。

  • GitHub リポジトリのソースコードの場合は、ソースコードとビルド仕様ファイルを含むリポジトリの HTTPS クローン URL。

  • Bitbucket リポジトリのソースコードの場合は、ソースコードとビルド仕様ファイルを含むリポジトリの HTTPS クローン URL。

Type

必須

ビルドするソースコードを含むリポジトリのタイプ。

タイプ: 文字列

有効な値:

  • BITBUCKET-ソースコードは Bitbucket リポジトリにあります。

    CODECOMMIT-ソースコードは CodeCommit リポジトリにあります。

    CODEPIPELINE-ソースコード設定は、CodePipeline のパイプラインのソースアクションで指定されています。

    GITHUB-ソースコードは GitHub リポジトリにあります。

    GITHUB_ENTERPRISE-ソースコードは GitHub エンタープライズリポジトリにあります。

    NO_SOURCE-プロジェクトに入力ソースコードがありません。

    S3— ソースコードは Amazon S3 入力バケットにあります。

VpcConfig

-VpcConfigオブジェクトは、CodeBuild がアクセスする VPC 設定に関する情報を提供します。

これには、次の属性を含めることができます。

SecurityGroupIds

オプション

Amazon VPC 内の 1 つ以上のセキュリティグループ ID のリスト。

タイプ: 文字列の配列

配列メンバー: 5 つの項目の最大数。

商品ごとの最小長さ: 1

Subnets

オプション

Amazon VPC 内の 1 つ以上のサブネット ID のリスト。

タイプ: 文字列の配列

文字列の最大数: 16

商品ごとの最小長さ: 1

VpcId

オプション

VPC の ID。

タイプ: 文字列

最小長: 1

AwsDynamoDbTable

-AwsDynamoDbTableオブジェクトは、DynamoDB テーブルに関する詳細を提供します。

"AwsDynamoDbTable": { "AttributeDefinitions": [ { "AttributeName": "attribute1", "AttributeType": "value 1" }, { "AttributeName": "attribute2", "AttributeType": "value 2" }, { "AttributeName": "attribute3", "AttributeType": "value 3" } ], "BillingModeSummary": { "BillingMode": "PAY_PER_REQUEST", "LastUpdateToPayPerRequestDateTime": "2019-12-03T15:23:10.323Z" }, "CreationDateTime": "2019-12-03T15:23:10.248Z", "GlobalSecondaryIndexes": [ { "Backfilling": false, "IndexArn": "arn:aws:dynamodb:us-west-2:111122223333:table/exampleTable/index/exampleIndex", "IndexName": "standardsControlArnIndex", "IndexSizeBytes": 1862513, "IndexStatus": "ACTIVE", "ItemCount": 20, "KeySchema": [ { "AttributeName": "City", "KeyType": "HASH" }, { "AttributeName": "Date", "KeyType": "RANGE" } ], "Projection": { "NonKeyAttributes": ["predictorName"], "ProjectionType": "ALL" }, "ProvisionedThroughput": { "LastIncreaseDateTime": "2019-03-14T13:21:00.399Z", "LastDecreaseDateTime": "2019-03-14T12:47:35.193Z", "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 100, "WriteCapacityUnits": 50 }, } ], "GlobalTableVersion": "V1", "ItemCount": 2705, "KeySchema": [ { "AttributeName": "zipcode", "KeyType": "HASH" } ], "LatestStreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/exampleTable/stream/2019-12-03T23:23:10.248", "LatestStreamLabel": "2019-12-03T23:23:10.248", "LocalSecondaryIndexes": [ { "IndexArn": "arn:aws:dynamodb:us-east-1:111122223333:table/exampleGroup/index/exampleId", "IndexName": "CITY_DATE_INDEX_NAME", "KeySchema": [ { "AttributeName": "zipcode", "KeyType": "HASH" } ], "Projection": { "NonKeyAttributes": ["predictorName"], "ProjectionType": "ALL" }, } ], "ProvisionedThroughput": { "LastIncreaseDateTime": "2019-03-14T13:21:00.399Z", "LastDecreaseDateTime": "2019-03-14T12:47:35.193Z", "NumberOfDecreasesToday": 0, "ReadCapacityUnits": 100, "WriteCapacityUnits": 50 }, "Replicas": [ { "GlobalSecondaryIndexes":[ { "IndexName": "CITY_DATE_INDEX_NAME", "ProvisionedThroughputOverride": { "ReadCapacityUnits": 10 } } ], "KmsMasterKeyId" : "KmsMasterKeyId" "ProvisionedThroughputOverride": { "ReadCapacityUnits": 10 }, "RegionName": "regionName", "ReplicaStatus": "CREATING", "ReplicaStatusDescription": "replicaStatusDescription" } ], "RestoreSummary" : { "SourceBackupArn": "arn:aws:dynamodb:us-west-2:111122223333:table/exampleTable/backup/backup1", "SourceTableArn": "arn:aws:dynamodb:us-west-2:111122223333:table/exampleTable", "RestoreDateTime": "2020-06-22T17:40:12.322Z", "RestoreInProgress": true }, "SseDescription": { "InaccessibleEncryptionDateTime": "2018-01-26T23:50:05.000Z", "Status": "ENABLED", "SseType": "KMS", "KmsMasterKeyArn": "arn:aws:kms:us-east-1:111122223333:key/key1" }, "StreamSpecification" : { "StreamEnabled": true, "StreamViewType": "NEW_IMAGE" }, "TableId": "example-table-id-1", "TableName": "example-table", "TableSizeBytes": 1862513, "TableStatus": "ACTIVE" }

これには、次の属性を含めることができます。

AttributeDefinitions

オプション

テーブルの属性定義のリスト。

タイプ: オブジェクトの配列。

BillingModeSummary

オプション

テーブル上の読み取り/書き込みキャパシティーの請求に関する情報。

タイプ: オブジェクト

CreationDateTime

オプション

テーブルの作成日を示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"CreationDateTime": "2020-06-22T17:40:12.322Z"
GlobalSecondaryIndexes

オプション

テーブルのグローバルセカンダリインデックスのリスト。

タイプ: オブジェクトの配列

GlobalTableVersion

オプション

使用されているグローバルテーブルのバージョン。

タイプ: 文字列

ItemCount

オプション

テーブル内の項目数。

タイプ: 数値

KeySchema

オプション

テーブルの主キー構造。

タイプ: オブジェクトの配列

LatestStreamArn

オプション

テーブルの最新ストリームの ARN。

タイプ: 文字列

LatestStreamLabel

オプション

最新のストリームのラベル。ラベルが一意の識別子ではありません。

タイプ: 文字列

LocalSecondaryIndexes

オプション

テーブルのローカルセカンダリインデックスのリスト。

タイプ: オブジェクトの配列

ProvisionedThroughput

オプション

テーブルのプロビジョニングされたスループットに関する情報。

タイプ: オブジェクト

Replicas

オプション

このテーブルのレプリカのリスト。

タイプ: オブジェクトの配列

RestoreSummary

オプション

リストアに関する情報 テーブルに対してをお使いください。

タイプ: オブジェクト

SseDescription

オプション

テーブルのサーバー側の暗号化に関する情報。

タイプ: オブジェクト

StreamSpecification

オプション

テーブルの現在の DynamoDB Streams 設定。

タイプ: オブジェクト

TableId

オプション

テーブルの識別子。

タイプ: 文字列

TableName

オプション

テーブルの名前。

タイプ: 文字列

最小長: 3

最大長: 255

TableSizeBytes

オプション

テーブルの合計サイズ (バイト単位)。

タイプ: 整数

TableStatus

オプション

テーブルの現在の状態。

タイプ: 文字列

有効な値: CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED

AttributeDefinitions

-AttributeDefinitionsオブジェクトには、テーブルの属性定義のリストが含まれます。

これには、次の属性を含めることができます。

AttributeName

オプション

属性の名前。

タイプ: 文字列

AttributeType

オプション

属性のタイプ。

タイプ: 文字列

BillingModeSummary

-BillingModeSummaryオブジェクトは、テーブルの読み取り/書き込みキャパシティーの課金に関する情報を提供します。

これには、次の属性を含めることができます。

BillingMode

オプション

読み取りと書き込みのスループットに対する課金方法と容量の管理方法。

タイプ: 文字列

有効な値: PROVISIONED | PAY_PER_REQUEST

LastUpdateToPayPerRequestDateTime

オプション

課金モードがPAY_PER_REQUESTは、課金モードがその値に設定されている日を示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"LastUpdateToPayPerRequestDateTime": "2020-06-22T17:40:12.322Z"

GlobalSecondaryIndexes

-GlobalSecondaryIndexesオブジェクトには、テーブルのグローバルセカンダリインデックスのリストが含まれます。

これには、次の属性を含めることができます。

Backfilling

オプション

インデックスが現在バックフィルされているかどうか。

タイプ: ブール値

IndexArn

オプション

インデックスの ARN。

タイプ: 文字列

IndexName

オプション

インデックスの名前。

タイプ: 文字列

IndexSizeBytes

オプション

インデックスの合計サイズ (バイト単位)。

タイプ: 数値

IndexStatus

オプション

インデックスの現在の状態。

タイプ: 文字列

有効な値: CREATING|UPDATING|DELETING|ACTIVE

ItemCount

オプション

インデックス内の項目数。

タイプ: 数値

KeySchema

オプション

インデックスのキースキーマ。

タイプ: オブジェクトの配列

Projection

オプション

テーブルからインデックスにコピーされる属性。

タイプ: オブジェクト

ProvisionedThroughput

オプション

インデックスのプロビジョニングされたスループット設定に関する情報。

タイプ: オブジェクト

KeySchema

-KeySchemaオブジェクトには、テーブルのキースキーマ、グローバルセカンダリインデックス、またはローカルセカンダリインデックスが含まれます。

キースキーマの各コンポーネントには、次の属性を含めることができます。

AttributeName

オプション

属性の名前。

タイプ: 文字列

KeyType

オプション

属性に使用されるキーのタイプ。

タイプ: 文字列

有効な値: HASH | RANGE

LocalSecondaryIndexes

LocalSecondaryIndexes には、以下の属性を含めることができます。

IndexArn

オプション

インデックスの ARN。

タイプ: 文字列

IndexName

オプション

インデックスの名前。

タイプ: 文字列

最小長: 3

最大長: 255

KeySchema

オプション

インデックスの完全なキースキーマ。

タイプ: オブジェクトの配列

Projection

オプション

テーブルからインデックスにコピーされる属性。自動的に射影されるプライマリキー属性とインデックスキー属性とは別に、これらが追加されます。

タイプ: オブジェクト

Projection(グローバルおよびローカルセカンダリインデックスの場合)

グローバルセカンダリインデックスとローカルセカンダリインデックスの場合、Projectionオブジェクトは、テーブルからインデックスにコピーされる属性を識別します。

これには、次の属性を含めることができます。

NonKeyAttributes

オプション

インデックスに射影される非キー属性。各属性について、属性名を指定します。

タイプ: 文字列の配列

最大項目数はです。 20

属性ごとの最小長: 1

属性ごとの最大長: 225

ProjectionType

オプション

インデックスに射影される属性のタイプ。

タイプ: 文字列

有効な値: ALL | KEYS_ONLY | INCLUDE

ProvisionedThroughput

-ProvisionedThroughputオブジェクトには、テーブルまたはグローバルセカンダリインデックスのプロビジョニングされたスループットに関する情報が含まれます。

これには、次の属性を含めることができます。

LastDecreaseDateTime

オプション

プロビジョニングされたスループットが最後に減少した時刻を示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"LastDecreaseDateTime": "2020-06-22T17:40:12.322Z"
LastIncreaseDateTime

オプション

プロビジョニングされたスループットが最後に増加した日時を示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"LastIncreaseDateTime": "2020-06-22T17:40:12.322Z"
NumberOfDecreasesToday

オプション

現在の UTC 暦日の間に、プロビジョニングされたスループットが低下した回数。

タイプ: 数値

ReadCapacityUnits

オプション

1 秒間に消費される強力な整合性のある読み込みの最大数。この最大数を超えると、DynamoDB が ThrottlingException を返します。

タイプ: 数値

WriteCapacityUnits

オプション

1 秒間に消費される書き込みの最大数。この最大数を超えると、DynamoDB が ThrottlingException を返します。

タイプ: 数値

Replicas

-Replicasオブジェクトには、このテーブルのレプリカのリストが格納されます。

各レプリカには、次の属性を含めることができます。

GlobalSecondaryIndexes

オプション

レプリカのグローバルセカンダリインデックスのリスト。

タイプ: オブジェクトの配列

GlobalSecondaryIndexes.IndexName

オプション

インデックスの名前。

タイプ: 文字列

GlobalSecondaryIndexes.ProvisionedThroughputOverride

オプション

インデックスのプロビジョニングされたスループットのレプリカ固有の構成。

タイプ: オブジェクト

KmsMasterKeyID

オプション

レプリカの AWS KMS 暗号化に使用する AWS KMS カスタマーマスターキー (CMK) の識別子。

タイプ: 文字列

ProvisionedThroughputOverride

オプション

プロビジョニングされたスループットのレプリカ固有の構成。

タイプ: オブジェクト

RegionName

オプション

レプリカが配置されているリージョンの名前。

タイプ: 文字列

ReplicaStatus

オプション

レプリカの現在の状態。

タイプ: 文字列

有効な値: CREATING | CREATION_FAILED | UPDATING | DELETING | ACTIVE

ReplicaStatusDescription

オプション

レプリカのステータスに関する詳細情報。

タイプ: 文字列

-ProvisionedThroughputOverrideオブジェクトは、テーブルまたはグローバルセカンダリインデックスのプロビジョニングされたスループットのレプリカ固有の設定を提供します。

これには、次の属性を含めることができます。

ReadCapacityUnits

オプション

レプリカの読み込みキャパシティーユニット。

タイプ: 数値

最小値はです。 1

RestoreSummary

-RestoreSummaryオブジェクトは、テーブルの復元に関する情報を提供します。

これには、次の属性を含めることができます。

RestoreDateTime

オプション

テーブルが復元された時点を示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"RestoreDateTime": "2020-06-22T17:40:12.322Z"
RestoreInProgress

オプション

リストアは現在進行中です。

タイプ: ブール値

SourceBackupArn

オプション

テーブルが復元されたソースバックアップの ARN。

タイプ: 文字列

SourceTableArn

オプション

バックアップのソーステーブルの ARN。

タイプ: 文字列

SseDescription

-SseDescriptionオブジェクトは、テーブルのサーバー側の暗号化に関する情報を提供します。

これには、次の属性を含めることができます。

InaccessibleEncryptionDateTime

オプション

キーにアクセスできない場合、DynamoDB がキーにアクセスできないことを検出した日時。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"InaccessibleEncryptionDateTime": "2020-06-22T17:40:12.322Z"
KmsMasterKeyArn

オプション

AWS KMS 暗号化に使用する AWS KMS カスタマーマスターキー (CMK) の ARN。

タイプ: 文字列

SseType

オプション

サーバー側の暗号化の種類。

タイプ: 文字列

有効な値: KMS

Status

オプション

サーバー側の暗号化のステータス。

タイプ: 文字列

有効な値: ENABLED | UPDATING

StreamSpecification

-StreamSpecificationオブジェクトには、テーブルの現在の DynamoDB Streams 設定が含まれます。

これには、次の属性を含めることができます。

StreamEnabled

オプション

テーブルで DynamoDB Streams を有効にするかどうかを指定します。

タイプ: ブール値

StreamViewType

オプション

テーブルに書き込まれている情報を決定します。

タイプ: 文字列

有効な値: NEW_IMAGE|OLD_IMAGE|NEW_AND_OLD_IMAGES|KEYS_ONLY

AwsEc2Eip

-AwsEc2Eipオブジェクトは、Elastic IP アドレスに関する情報を提供します。

"AwsEc2Eip": { "InstanceId": "instance1", "PublicIp": "192.0.2.04", "AllocationId": "eipalloc-example-id-1", "AssociationId": "eipassoc-example-id-1", "Domain": "vpc", "PublicIpv4Pool": "anycompany", "NetworkBorderGroup": "eu-central-1", "NetworkInterfaceId": "eni-example-id-1", "NetworkInterfaceOwnerId": "777788889999", "PrivateIpAddress": "192.0.2.03" }

AwsEc2Eip オブジェクトには、次の属性を含めることができます。

AllocationId

オプション

Amazon VPC で使用する Elastic IP アドレスの割り当てを表すために AWS によって割り当てられた ID。

タイプ: 文字列

AssociationId

オプション

Elastic IP アドレスと EC2 インスタンスの関連付けを表す識別子。

タイプ: 文字列

Domain

オプション

アドレスを割り当てるドメイン。

アドレスが VPC 内の EC2 インスタンスで使用される場合は、Domainvpc。そうでなければ、Domainstandard

タイプ: 文字列

有効な値: standard | vpc

InstanceId

オプション

EC2 インスタンスの ID。

タイプ: 文字列

NetworkBorderGroup

オプション

Elastic IP アドレスのアドバタイズ元の場所の名前。

タイプ: 文字列

NetworkInterfaceId

オプション

ネットワークインターフェイスの識別子。

タイプ: 文字列

NetworkInterfaceOwnerId

オプション

ネットワークインターフェイスの所有者の AWS アカウント ID。

タイプ: 文字列

形式: 12 桁の数字にする必要があります。

PrivateIpAddress

オプション

Elastic IP アドレスに関連付けられるプライベート IP アドレス。

タイプ: IPv4

PublicIp

オプション

EC2 インスタンスに関連付けられたパブリック IP アドレス。

タイプ: IPv4

PublicIpv4Pool

オプション

IP アドレスプールの識別子。このパラメータを使用すると、Amazon EC2 がアドレスプールから IP アドレスを選択できます。

タイプ: 文字列

AwsEc2Instance

Amazon EC2 インスタンスの詳細。

タイプ: オブジェクト

AwsEc2Instance オブジェクトには、次の属性を含めることができます。

IamInstanceProfileArn

オプション

インスタンスの IAM プロファイルの ARN。

タイプ: 文字列

形式: AWS ARN 形式に準拠しています。

ImageId

オプション

インスタンスの Amazon Machine Image (AMI) の ID。

タイプ: 文字列

最大長: 64

IpV4Addresses

オプション

インスタンスに関連付けられている IPv4 アドレス。

タイプ: 最大 10 個の IPv4 アドレスの配列

IpV6Addresses

オプション

インスタンスに関連付けられている IPv6 アドレス。

タイプ: 最大 10 個の IPv6 アドレスの配列

KeyName

オプション

インスタンスに関連付けられているキー名。

タイプ: 文字列

最大長: 128

LaunchedAt

オプション

インスタンスがいつ起動されたかを示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

SubnetId

オプション

インスタンスが作成されたサブネットの識別子。

タイプ: 文字列

最大長: 32

Type

オプション

インスタンスのインスタンスタイプ。これは有効な EC2 インスタンスタイプである必要があります。

タイプ: 文字列

最大長: 16

VpcId

オプション

インスタンスが起動された VPC の識別子。

タイプ: 文字列

最大長: 32

AwsEc2NetworkAcl

-AwsEc2NetworkAclオブジェクトには、Amazon EC2 ネットワークアクセスコントロールリスト (ACL) に関する詳細が含まれています。

AwsEc2NetworkAcl: { "IsDefault": false, "NetworkAclId": "acl-1234567890abcdef0", "OwnerId": "123456789012", "VpcId": "vpc-1234abcd", "Associations": [{ "NetworkAclAssociationId": "aclassoc-abcd1234", "NetworkAclId": "acl-021345abcdef6789", "SubnetId": "subnet-abcd1234" }], "Entries": [{ "CidrBlock": "10.24.34.0/23", "Egress": true, "IcmpTypeCode": { "Code": 10, "Type": 30 }, "Ipv6CidrBlock": "2001:DB8::/32", "PortRange": { "From": 20, "To": 40 }, "Protocol": "tcp", "RuleAction": "allow", "RuleNumber": 100 }] }

AwsEc2NetworkAcl には、以下の属性を含めることができます。

Associations

オプション

ネットワーク ACL とサブネット間の関連付け。

タイプ: オブジェクトの配列

Entries

オプション

ネットワーク ACL のルールセット。

タイプ: オブジェクトの配列

IsDefault

オプション

これが VPC のデフォルトのネットワーク ACL であるかどうか。

タイプ: ブール値

NetworkAclId

オプション

ネットワーク ACL の識別子。

タイプ: 文字列

OwnerId

オプション

ネットワーク ACL を所有する AWS アカウントの識別子。

タイプ: 文字列

VpcId

オプション

ネットワーク ACL の VPC の ID。

タイプ: 文字列

Associations

-Associationsオブジェクトには、ネットワーク ACL とサブネット間の関連付けが含まれます。

各関連付けには、次の属性を含めることができます。

NetworkAclAssociationId

オプション

ネットワーク ACL とサブネット間の関連付けの識別子。

タイプ: 文字列

NetworkAclId

オプション

ネットワーク ACL の識別子。

タイプ: 文字列

SubnetId

オプション

ネットワーク ACL に関連付けられるサブネットの ID。

タイプ: 文字列

Entries

-Entriesオブジェクトには、ネットワーク ACL のルールが含まれます。各ルールは、IP アドレス、トラフィック方向、ポート、およびプロトコルに基づいてアクセスを許可または拒否します。

各ルールには、次の属性を含めることができます。

CidrBlock

オプション

アクセスを拒否または許可する IPV4 ネットワーク範囲。

タイプ: 文字列

形式: CIDR 表記を使用します。

Egress

オプション

ルールが出力ルールかどうか。出力ルールは、サブネットから出るトラフィックに適用されるルールです。

タイプ: ブール値

IcmpTypeCode

オプション

アクセスを拒否または許可する Internet Control Message Protocol (ICMP) タイプおよびコード。

タイプ: オブジェクト

IcmpTypeCode.Code

オプション

アクセスを拒否または許可する ICMP コード。

すべてのコードを拒否または許可するには、-1

タイプ: 数値

IcmpTypeCode.Type

オプション

アクセスを拒否または許可する ICMP タイプ。

すべての型を拒否または許可するには、-1

タイプ: 数値

Ipv6CidrBlock

アクセスを拒否または許可する IPV6 ネットワーク範囲。

タイプ: 文字列

形式: CIDR 表記を使用します。

PortRange

オプション

TCP または UDP プロトコルの場合、ルールが適用されるポートの範囲。

タイプ: オブジェクト

PortRange.From

オプション

ポート範囲の最初のポート。

タイプ: 数値

PortRange.To

オプション

ポート範囲の最後のポート。

タイプ: 数値

Protocol

オプション

ルールが適用されるプロトコル。

すべてのプロトコルへのアクセスを拒否または許可するには、-1

タイプ: 文字列

RuleAction

オプション

ルールを使用してアクセスを許可するか、アクセスを拒否するかを指定します。

タイプ: 文字列

有効な値: allow | deny

RuleNumber

オプション

ルール番号。ルールは、番号順に処理されます。

タイプ: 数値

AwsEc2NetworkInterface

-AwsEc2NetworkInterfaceオブジェクトは、Amazon EC2 ネットワークインターフェイスに関する情報を提供します。

"AwsEc2NetworkInterface": { "Attachment": { "AttachTime": "2019-01-01T03:03:21Z", "AttachmentId": "eni-attach-43348162", "DeleteOnTermination": true, "DeviceIndex": 123, "InstanceId": "i-1234567890abcdef0", "InstanceOwnerId": "123456789012", "Status": 'ATTACHED' }, "SecurityGroups": [ { "GroupName": "my-security-group", "GroupId": "sg-903004f8" }, ], "NetworkInterfaceId": 'eni-686ea200', "SourceDestCheck": false }

AwsEc2NetworkInterface オブジェクトには、次の属性を含めることができます。

Attachment

オプション

ネットワークインターフェイスのアタッチメントに関する情報。

タイプ: オブジェクト

Ipv6Addresses

オプション

ネットワークインターフェイスに関連付けられている IPv6 アドレス。

タイプ: オブジェクトの配列

NetworkInterfaceId

オプション

ネットワークインターフェイスの ID。

タイプ: 文字列

PrivateIpAddresses

オプション

ネットワークインターフェイスに関連付けられたプライベート IPv4 アドレス。

タイプ: オブジェクトの配列

PublicDnsName

オプション

ネットワークインターフェイスのパブリック DNS 名。

タイプ: 文字列

PublicIp

オプション

ネットワークインターフェイスにバインドされた Elastic IP アドレスのアドレス。

タイプ: 文字列

SecurityGroups

オプション

ネットワークインターフェイスのセキュリティグループ。

タイプ: グループオブジェクトの配列

SourceDestCheck

オプション

インスタンスへのトラフィックまたはインスタンスからのトラフィックを検証するかどうかを示します。

タイプ: ブール値

Attachment

Attachment オブジェクトは、ネットワークインターフェイスのアタッチメントに関する情報を提供します。

これには、次の属性を含めることができます。

AttachmentId

オプション

ネットワークインターフェイスのアタッチメントの ID。

タイプ: 文字列

AttachTime

オプション

アタッチメントがいつ開始されたかを示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

DeleteOnTermination

オプション

インスタンスの終了時にネットワークインターフェイスを自動的に削除するかどうかを示します。

タイプ: ブール値

DeviceIndex

オプション

インスタンス上のネットワークインターフェイス接続のデバイスインデックス。

タイプ: 整数

InstanceId

オプション

インスタンスの ID。

タイプ: 文字列

InstanceOwnerId

オプション

インスタンスの所有者の AWS アカウント ID。

タイプ: 文字列

Status

オプション

アタッチ状態。

タイプ: 文字列

有効な値: attaching|attached|detaching|detached

Ipv6Addresses

Ipv6Addressesネットワークインターフェイスに関連付けられている IPV6 アドレスを示します。各 IPV6 アドレスには、次の属性を含めることができます。

Ipv6Address

オプション

IPV6 アドレス。

タイプ: 文字列

PrivateIpAddresses

PrivateIpAddressesネットワークインターフェイスに関連付けられているプライベート IPv4 アドレスのリストが含まれます。

各プライベート IPv4 アドレスには、次の属性を含めることができます。

PrivateDnsName

オプション

IP アドレスのプライベート DNS 名。

タイプ: 文字列

PrivateIpAddress

オプション

IP アドレス。

タイプ: 文字列

SecurityGroups

SecurityGroups オブジェクトには、ネットワークインターフェイスのセキュリティグループのリストが含まれます。

各セキュリティグループには、次の属性を含めることができます。

GroupId

オプション

セキュリティグループの ID.

タイプ: 文字列

GroupName

オプション

セキュリティグループの名前。

タイプ: 文字列

AwsEc2SecurityGroup

-AwsEc2SecurityGroupオブジェクトは、Amazon EC2 セキュリティグループを記述します。

"AwsEc2SecurityGroup": { "GroupName": "MySecurityGroup", "GroupId": "sg-903004f8", "OwnerId": "123456789012", "VpcId": "vpc-1a2b3c4d", "IpPermissions": [ { "IpProtocol": "-1", "IpRanges": [], "UserIdGroupPairs": [ { "UserId": "123456789012", "GroupId": "sg-903004f8" } ], "PrefixListIds": [ {"PrefixListId": "pl-63a5400a"} ] }, { "PrefixListIds": [], "FromPort": 22, "IpRanges": [ { "CidrIp": "203.0.113.0/24" } ], "ToPort": 22, "IpProtocol": "tcp", "UserIdGroupPairs": [] } ] }

AwsEc2SecurityGroup オブジェクトには、次の属性を含めることができます。

GroupId

オプション

セキュリティグループの ID.

タイプ: 文字列

GroupName

オプション

セキュリティグループの名前。

タイプ: 文字列

IpPermissions

オプション

セキュリティグループに関連付けられたインバウンドルール。

タイプ: IP アクセス許可オブジェクトの配列

IpPermissionsEgress

オプション

[VPC のみ] セキュリティグループに関連付けられたアウトバウンドルール。

タイプ: IP アクセス許可オブジェクトの配列

OwnerId

オプション

セキュリティグループの所有者の AWS アカウント ID。

タイプ: 文字列

VpcId

オプション

[VPC のみ] セキュリティグループの VPC の ID。

タイプ: 文字列

IP アクセス許可オブジェクト

IpPermissions および IpPermissionsEgress オブジェクトには、両方とも IP アクセス許可オブジェクトの配列が含まれます。

各 IP アクセス許可オブジェクトには、次の属性を含めることができます。

FromPort

オプション

TCP および UDP プロトコルのポート範囲の開始番号。または ICMP/ICMPv6 タイプの番号。

-1 の値は、すべての ICMP/ICMPv6 タイプを示します。すべての ICMP/ICMPv6 タイプを指定した場合、すべてのコードを指定する必要があります。

タイプ: 整数

IpProtocol

オプション

IP プロトコルの名前 (tcpudpicmpicmpv6) または番号 (「プロトコル番号」を参照)。

[VPC のみ] -1 を使用してすべてのプロトコルを指定します。

セキュリティグループルールを許可するときに、-1、またはtcpudpicmp、または icmpv6 以外のプロトコル番号を指定すると、指定したポート範囲に関係なく、すべてのポートでトラフィックが許可されます。

tcpudp、および icmp には、ポート範囲を指定する必要があります。

icmpv6 では、ポート範囲はオプションです。ポート範囲を省略すると、すべてのタイプとコードのトラフィックが許可されます。

タイプ: 文字列

IpRanges

オプション

IP アドレスの範囲。

タイプ: IP 範囲オブジェクトの配列

PrefixListIds

オプション

[VPC のみ] AWS サービスのプレフィックスリスト ID。アウトバウンドルールでは、これは、セキュリティグループに関連付けられたインスタンスから VPC エンドポイントを介してアクセスする AWS サービスです。

タイプ: プレフィックスリスト ID オブジェクトの配列

ToPort

オプション

TCP および UDP プロトコルのポート範囲の終了番号、または ICMP/ICMPv6 コード。

-1 の値はすべての ICMP/ICMPv 6 コードを示しています。すべての ICMP/ICMPv6 タイプを指定した場合、すべてのコードを指定する必要があります。

タイプ: 整数

UserIdGroupPairs

オプション

セキュリティグループと AWS アカウント ID のペア。

タイプ: ユーザー ID グループペアオブジェクトの配列

IpRanges 配列内の各エントリには、次の属性を含めることができます。

CidrIp

オプション

IP アドレスの範囲。

CIDR 範囲またはソースセキュリティグループのいずれかを指定できますが、両方を指定することはできません。

単一の IPv4 アドレスを指定するには、/32 プレフィックス長を使用します。

単一の IPv6 アドレスを指定するには、/128 プレフィックス長を使用します。

タイプ: 文字列

PrefixListIds 配列内の各エントリには、次の属性を含めることができます。

PrefixListId

オプション

プレフィックスの ID。

タイプ: 文字列

UserIdGroupPairs 配列内の各エントリには、次の属性を含めることができます。

GroupId

オプション

セキュリティグループの ID.

タイプ: 文字列

UserId

オプション

AWS アカウントの ID。

別の VPC で参照されるセキュリティグループの場合、参照されるセキュリティグループのアカウント ID がレスポンスで返されます。参照されるセキュリティグループを削除すると、この値は返されません。

[Amazon EC2-Classic] 別の AWS アカウントのセキュリティグループを参照するルールを追加または削除する場合に必要です。

タイプ: 文字列

AwsEc2Subnet

-AwsEc2Subnetオブジェクトは、Amazon EC2 のサブネットに関する情報を提供します。

AwsEc2Subnet: { "AssignIpv6AddressOnCreation": false, "AvailabilityZone": "us-west-2c", "AvailabilityZoneId": "usw2-az3", "AvailableIpAddressCount": 8185, "CidrBlock": "10.0.0.0/24", "DefaultForAz": false, "MapPublicIpOnLaunch": false, "OwnerId": "123456789012", "State": "available", "SubnetArn": "arn:aws:ec2:us-west-2:123456789012:subnet/subnet-d5436c93", "SubnetId": "subnet-d5436c93", "VpcId": "vpc-153ade70", "Ipv6CidrBlockAssociationSet": [{ "AssociationId": "subnet-cidr-assoc-EXAMPLE", "Ipv6CidrBlock": "2001:DB8::/32", "CidrBlockState": "associated" }] }

AWSEc2Subnet には、以下の属性を含めることができます。

AssignIpv6AddressOnCreation

オプション

このサブネットで作成されたネットワークインターフェイスに IPV6 アドレスを割り当てるかどうか。

タイプ: ブール値

AvailabilityZone

オプション

サブネットのアベイラビリティーゾーン。

タイプ: 文字列

AvailabilityZoneId

オプション

サブネットのアベイラビリティーゾーンの識別子。

タイプ: 文字列

AvailableIpAddressCount

オプション

サブネット内で使用可能な IPV4 アドレスの数。停止したインスタンスのアドレスは含まれません。

タイプ: 数値

CidrBlock

オプション

サブネットに割り当てられている IPV4 CIDR ブロック。

タイプ: 文字列

形式: CIDR 表記を使用します。

DefaultForAz

オプション

このサブネットがアベイラビリティーゾーンのデフォルトサブネットであるかどうか。

タイプ: ブール値

Ipv6CidrBlockAssociationSet

オプション

サブネットに関連付けられる IPV6 CIDR ブロック。

タイプ: オブジェクトの配列

MapPublicIpOnLaunch

オプション

このサブネットのインスタンスがパブリック IP アドレスを受け取るかどうかを指定します。

タイプ: ブール値

OwnerId

オプション

サブネットを所有する AWS アカウントの識別子。

タイプ: 文字列

State

オプション

サブネットの現在の状態。

タイプ: 文字列

有効な値: pending | available

SubnetArn

オプション

サブネットの ARN。

タイプ: 文字列

SubnetId

オプション

サブネットの識別子。

タイプ: 文字列

VpcId

オプション

サブネットを含む VPC の識別子。

タイプ: 文字列

Ipv6CidrBlockAssociationSet

Ipv6CidrBlockAssociationSetサブネットに関連付けられる IPV6 CIDR ブロックに関する情報が含まれています。

各 CIDR ブロックには、次の属性を含めることができます。

AssociationId

オプション

関連付けの識別子。

タイプ: 文字列

Ipv6CidrBlock

オプション

IPv6 CIDR ブロック。

タイプ: 文字列

形式: CIDR 表記を使用します。

CidrBlockState

オプション

IPV6 CIDR ブロックの状態。

タイプ: 文字列

有効な値: associating|associated|disassociating|disassociated|failing|failed

AwsEc2Volume

-AwsEc2Volumeオブジェクトは、EC2 ボリュームの詳細を提供します。

"AwsEc2Volume": { "Attachments": [ { "AttachTime": "2017-10-17T14:47:11Z", "DeleteOnTermination": true, "InstanceId": "i-123abc456def789g", "Status": "attached" } ], "CreateTime": "2020-02-24T15:54:30Z", "Encrypted": true, "KmsKeyId": "arn:aws:kms:us-east-1:111122223333:key/wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "Size": 80, "SnapshotId": "", "Status": "available" }

AwsEc2Volume オブジェクトには、次の属性を含めることができます。

Attachments

オプション

ボリュームアタッチメント。

タイプ: オブジェクトの配列

CreateTime

オプション

ボリュームが作成された日時を示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

Encrypted

オプション

ボリュームが暗号化されているかどうか。

タイプ: ブール値

KmsKeyId

オプション

ボリュームのボリューム暗号化キーを保護するために使用された AWS KMS カスタマーマスターキー (CMK) の ARN。

タイプ: 文字列

Size

オプション

ボリュームのサイズ (GiB 単位)。

タイプ: 整数

SnapshotId

オプション

ボリュームの作成元になったスナップショット。

タイプ: 文字列

Status

オプション

ボリュームの状態。

タイプ: 文字列

有効な値: creating|available|in-use|deleting|deleted|error

Attachments

-Attachmentsオブジェクトには、EC2 ボリュームの添付ファイルのセットが含まれます。各添付ファイルには、次の属性を含めることができます。

AttachTime

オプション

添付ファイルが開始された日時。

タイプ: 文字列 (タイムスタンプ)

形式: yyyy-MM-ddTHH:mm:ssZ

DeleteOnTermination

オプション

EC2 インスタンスの終了時に EBS ボリュームを削除するかどうか。

タイプ: ブール値

InstanceId

オプション

EC2 インスタンスの ID。

タイプ: 文字列

Status

オプション

ボリュームのアタッチメント状態。

タイプ: 文字列

有効な値: attaching | attached | detaching | detached | busy

AwsEc2Vpc

-AwsEc2Vpcオブジェクトは、EC2 Virtual Private Cloud (VPC) に関する詳細を提供します。

"AwsEc2Vpc": { "CidrBlockAssociationSet": [ { "AssociationId": "vpc-cidr-assoc-0dc4c852f52abda97", "CidrBlock": "192.0.2.0/24", "CidrBlockState": "associated" } ], "DhcpOptionsId": "dopt-4e42ce28", "Ipv6CidrBlockAssociationSet": [ { "AssociationId": "vpc-cidr-assoc-0dc4c852f52abda97", "CidrBlockState": "associated", "Ipv6CidrBlock": "192.0.2.0/24" } ], "State": "available" }

AwsEc2Vpc オブジェクトには、次の属性を含めることができます。

CidrBlockAssociationSet

オプション

VPC に関連付けられる IPv4 CIDR ブロックに関する情報。

タイプ: オブジェクトの配列

DhcpOptionsId

オプション

VPC に関連付けられた、動的ホスト構成プロトコル (DHCP) オプションのセットの ID。デフォルトのオプションが VPC に関連付けられている場合、これはdefault

タイプ: 文字列

最大長: 32

IpV6CidrBlockAssociationSet

オプション

VPC に関連付けられる IPv6 CIDR ブロックに関する情報。

タイプ: オブジェクトの配列。

State

オプション

VPC の現在の状態。

タイプ: 文字列

最大長: 32

有効な値: pending | available

CidrBlockAssociationSet

-CidrBlockAssociationSetオブジェクトは、IPV4 CIDR ブロックの関連付けのリストを提供します。

各 CIDR ブロックの関連付けには、次の属性を含めることができます。

AssociationId

オプション

IPv4 CIDR ブロックのアソシエーション ID。

タイプ: 文字列

最大長: 32

CidrBlock

オプション

IPv4 CIDR ブロック。

タイプ: CIDR

CidrBlockState

オプション

CIDR ブロックの状態に関する情報。

タイプ: 文字列

最大長: 32

IpV6CidrBlockAssociationSet

-IPV6CidrBlockAssociationSetオブジェクトは、IPV6 CIDR ブロックの関連付けのリストを提供します。

各 CIDR ブロックの関連付けには、次の属性を含めることができます。

Associationid

オプション

IPv6 CIDR ブロックのアソシエーション ID。

タイプ: 文字列

最大長: 32

CidrBlockState

オプション

CIDR ブロックの状態に関する情報。

タイプ: 文字列

最大長: 32

IpV6CidrBlock

オプション

IPv6 CIDR ブロック。

タイプ: CIDR

AwsElasticBeanstalkEnvironment

-AwsElasticBeanstalkEnvironmentオブジェクトには、AWS Elastic Beanstalk 環境に関する詳細が含まれます。

"AwsElasticBeanstalkEnvironment": { "ApplicationName": "MyApplication", "Cname": "myexampleapp-env.devo-2.elasticbeanstalk-internal.com", "DateCreated": "2021-04-30T01:38:01.090Z", "DateUpdated": "2021-04-30T01:38:01.090Z", "Description": "Example description of my awesome application", "EndpointUrl": "eb-dv-e-p-AWSEBLoa-abcdef01234567890-021345abcdef6789.us-east-1.elb.amazonaws.com", "EnvironmentArn": "arn:aws:elasticbeanstalk:us-east-1:123456789012:environment/MyApplication/myapplication-env", "EnvironmentId": "e-abcd1234", "EnvironmentLinks": [ { "EnvironmentName": "myexampleapp-env", "LinkName": "myapplicationLink" } ], "EnvironmentName": "myapplication-env", "OptionSettings": [ { "Namespace": "aws:elasticbeanstalk:command", "OptionName": "BatchSize", "Value": "100" }, { "Namespace": "aws:elasticbeanstalk:command", "OptionName": "Timeout", "Value": "600" }, { "Namespace": "aws:elasticbeanstalk:command", "OptionName": "BatchSizeType", "Value": "Percentage" }, { "Namespace": "aws:elasticbeanstalk:command", "OptionName": "IgnoreHealthCheck", "Value": "false" }, { "Namespace": "aws:elasticbeanstalk:application", "OptionName": "Application Healthcheck URL", "Value": "TCP:80" } ], "PlatformArn": "arn:aws:elasticbeanstalk:us-east-1::platform/Tomcat 8 with Java 8 running on 64bit Amazon Linux/2.7.7", "SolutionStackName": "64bit Amazon Linux 2017.09 v2.7.7 running Tomcat 8 Java 8", "Status": "Ready", "Tier": { "Name": "WebServer" "Type": "Standard" "Version": "1.0" }, "VersionLabel": "Sample Application" }

AwsElasticBeanstalkEnvironment には、以下の属性を含めることができます。

ApplicationName

オプション

環境に関連付けられたアプリケーションの名前。

タイプ: 文字列

最小長: 1

最大長: 100

Cname

オプション

この環境の CNAME の URL。

タイプ: 文字列

最小長: 1

最大長: 255

DateCreated

オプション

この環境の作成日。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

DateUpdated

オプション

この環境が最後に変更された日付。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

Description

オプション

環境の説明。

タイプ: 文字列

EndpointUrl

オプション

ロードバランシングでオートスケーリングの環境の、ロードバランサーへの URL。単一インスタンスの環境では、インスタンスの IP アドレス。

タイプ: 文字列

EnvironmentArn

オプション

環境の ARN。

タイプ: 文字列

EnvironmentId

オプション

環境の識別子。

タイプ: 文字列

EnvironmentLinks

オプション

同じグループ内にある他の環境へのリンク。

タイプ: オブジェクトの配列

EnvironmentName

オプション

環境の名前。

タイプ: 文字列

OptionSettings

オプション

環境の構成設定。

タイプ: オブジェクトの配列

PlatformArn

オプション

環境のプラットフォームバージョンの ARN。

タイプ: 文字列

SolutionStackName

オプション

環境とともにデプロイされているソリューションスタックの名前。

タイプ: 文字列

Status

オプション

環境の現在のオペレーションステータス。

タイプ: 文字列

有効な値: Aborting|Launching|Updating|LinkingFrom|LinkingTo|Ready|Terminating|Terminated

Tier

オプション

環境の階層。

タイプ: オブジェクト

VersionLabel

オプション

環境のアプリケーションバージョン。

タイプ: 文字列

-EnvironmentLinksオブジェクトには、同じグループ内にある他の環境へのリンクに関する情報が含まれています。

各環境リンクには、次の属性を含めることができます。

EnvironmentName

オプション

リンク環境の名前。

タイプ: 文字列

LinkName

オプション

環境リンクの名前。

タイプ: 文字列

OptionSettings

-OptionSettingsオブジェクトには、環境の構成オプション設定が含まれます。Elastic Beanstalk で設定オプションの設定の詳細については、設定オプションAWS Elastic Beanstalk 開発者ガイドの「」。

各設定は、次の属性を持つオブジェクトで提供されます。

Namespace

オプション

構成オプションが関連付けられているリソースを識別するために使用されます。

タイプ: 文字列

OptionName

オプション

オプションの名前。

タイプ: 文字列

ResourceName

オプション

設定のリソース名。

タイプ: 文字列

最小長: 1

最大長: 256

Value

オプション

構成設定の値。

タイプ: 文字列

Tier

-Tierオブジェクトには、環境の層に関する情報が含まれています。

層には、次の属性を含めることができます。

Name

オプション

環境枠の名前。

タイプ: 文字列

有効な値: WebServer | Worker

Type

オプション

環境枠のタイプ。

タイプ: 文字列

有効な値: Standard | SQS/HTTP

Version

オプション

環境枠のバージョン。

タイプ: 文字列

AwsElasticSearchDomain

-AwsElasticSearchDomainオブジェクトは、Elasticsearch ドメインの詳細を提供します。

これには、次の属性を含めることができます。

AccessPolicies

オプション

新しい Amazon ES ドメインのアクセスポリシーを指定する IAM ポリシードキュメント。

タイプ: 文字列

DomainEndpointOptions

オプション

ドメインエンドポイントの追加オプション。

タイプ: オブジェクト

DomainStatus

オプション

ドメインステータスの詳細。

タイプ: オブジェクト

ElasticsearchVersion

オプション

弾性検索バージョン。

タイプ: 文字列

EncryptionAtRestOptions

オプション

保管時の暗号化の設定の詳細。

タイプ: オブジェクト

NodeToNodeEncryptionOptions

オプション

ノード間の暗号化の設定の詳細。

タイプ: オブジェクト

VPCOptions

オプション

Amazon ES が取得した情報VPCOptionsドメインのドメインコントローラーコントローラーコントローラーコントローラーコントローラー

タイプ: オブジェクト

DomainEndpointOptions

DomainEndpointOptions オブジェクトは、ドメインエンドポイントの追加オプションに関する情報を提供します。

これには、次の属性を含めることができます。

EnforceHTTPS

オプション

ドメインへのすべてのトラフィックが HTTPS 経由で到着することを要求するかどうか。

タイプ: ブール値

TLSSecurityPolicy

オプション

Elasticsearch ドメインの HTTPS エンドポイントに適用する TLS セキュリティポリシー。

タイプ: 文字列

有効な値:

  • Policy-Min-TLS-1-0-2019-07 (TLSv1.0 以上をサポートします)。

  • Policy-Min-TLS-1-2-2019-07 (TLSv1.2 のみをサポートします)。

DomainStatus

DomainStatus オブジェクトは、ドメインのステータスに関する詳細を提供します。

これには、次の属性を含めることができます。

DomainId

オプション

Amazon ES ドメイン用の一意の識別子。

タイプ: 文字列

DomainName

オプション

Amazon ES ドメインの名前。

ドメイン名は、AWS リージョン内の同じアカウントによって所有されるドメイン間で一意です。

最小長:3 文字

最大長:28文字

有効な値: 小文字で始まり、a ~ z、0 ~ 9、0 ~ 9、(ハイフン) を使用します。

タイプ: 文字列

Endpoint

オプション

インデックス、検索、データアップロードのリクエストを Amazon ES ドメインに送信するために使用されるドメイン固有のエンドポイント。

エンドポイントはサービス URL です。

タイプ: 文字列

Endpoints

オプション

Amazon ES ドメインが VPC エンドポイントを使用する場合に存在するキー値ペア。

タイプ: キーと値のペアのマップ

"vpc": "<VPC_ENDPOINT>"

EncryptionAtRestOptions

EncryptionAtRestOptions オブジェクトは、保管時の暗号化の設定に関する詳細を提供します。

これには、次の属性を含めることができます。

Enabled

オプション

保管時の暗号化が有効かどうか。

タイプ: ブール値

KmsKeyId

オプション

AWS KMS キー ID。形式は 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a です。

タイプ: 文字列

NodeToNodeEncryptionOptions

NodeToNodeEncryptionOptions オブジェクトは、ノード間の暗号化の設定に関する詳細を提供します。

これには、次の属性を含めることができます。

Enabled

オプション

ノード間の暗号化が有効かどうか。

タイプ: ブール値

VpcOptions

-VpcOptionsオブジェクトには、Amazon ES がVPCOptionsドメインのドメインコントローラーコントローラーコントローラーコントローラーコントローラー

これには、次の属性を含めることができます。

AvailabilityZones

オプション

VPC サブネットに関連付けられるアベイラビリティゾーンのリスト。

タイプ: 文字列の配列

SecurityGroupIds

オプション

ドメインの VPC エンドポイントに関連付けられるセキュリティグループ ID のリスト。。

タイプ: 文字列の配列。

SubnetIds

オプション

ドメインの VPC エンドポイントに関連付けられるサブネット ID のリスト。

タイプ: 文字列の配列

VPCId

オプション

VPC の ID。

タイプ: 文字列

AwsElbLoadBalancer

-AwsElbLoadBalancerオブジェクトには、Classic Load Balancer の詳細が含まれます。

"AwsElbLoadBalancer": { "AvailabilityZones": ["us-west-2a"], "BackendServerDescriptions": [ { "InstancePort": 80, "PolicyNames": ["doc-example-policy"] } ], "CanonicalHostedZoneName": "Z3DZXE0EXAMPLE", "CanonicalHostedZoneNameID": "my-load-balancer-444455556666.us-west-2.elb.amazonaws.com", "CreatedTime": "2020-08-03T19:22:44.637Z", "DnsName": "my-load-balancer-444455556666.us-west-2.elb.amazonaws.com", "HealthCheck": { "HealthyThreshold": 2, "Interval": 30, "Target": "HTTP:80/png", "Timeout": 3, "UnhealthyThreshold": 2 }, "Instances": [ { "InstanceId": "i-example" } ], "ListenerDescriptions": [ { "Listener": { "InstancePort": 443, "InstanceProtocol": "HTTPS", "LoadBalancerPort": 443, "Protocol": "HTTPS", "SslCertificateId": "arn:aws:iam::444455556666:server-certificate/my-server-cert" }, "PolicyNames": ["ELBSecurityPolicy-TLS-1-2-2017-01"] } ], "LoadBalancerAttributes": { "AccessLog": { "EmitInterval": 60, "Enabled": true, "S3BucketName": "doc-example-bucket", "S3BucketPrefix": "doc-example-prefix" }, "ConnectionDraining": { "Enabled": false, "Timeout": 300 }, "ConnectionSettings": { "IdleTimeout": 30 }, "CrossZoneLoadBalancing": { "Enabled": true } }, "LoadBalancerName": "example-load-balancer", "Policies": { "AppCookieStickinessPolicies": [ { "CookieName": "", "PolicyName": "" } ], "LbCookieStickinessPolicies": [ { "CookieExpirationPeriod": 60, "PolicyName": "my-example-cookie-policy" } ], "OtherPolicies": [ "my-PublicKey-policy", "my-authentication-policy", "my-SSLNegotiation-policy", "my-ProxyProtocol-policy", "ELBSecurityPolicy-2015-03" ] }, "Scheme": "internet-facing", "SecurityGroups": ["sg-example"], "SourceSecurityGroup": { "GroupName": "my-elb-example-group", "OwnerAlias": "444455556666" }, "Subnets": ["subnet-example"], "VpcId": "vpc-a01106c2" }

AwsElbLoadBalancer には、以下の属性を含めることができます。

AvailabilityZones

オプション

ロードバランサーのアベイラビリティーゾーンのリスト。

タイプ: 文字列の配列

BackendServerDescriptions

オプション

EC2 インスタンスの設定に関する情報。

タイプ: オブジェクトの配列

CanonicalHostedZoneName

オプション

ロードバランサーの Amazon Route 53 ホストゾーンの名前。

タイプ: 文字列

CanonicalHostedZoneNameID

オプション

ロードバランサーの Amazon Route 53 ホストゾーンの ID。

タイプ: 文字列

CreatedTime

オプション

ロードバランサーが作成された日時を示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

"CreatedTime": "2017-03-22T13:22:13.933Z"
DnsName

オプション

ロードバランサーの DNS 名。

タイプ: 文字列

HealthCheck

オプション

ロードバランサーで実行されるヘルスチェックに関する情報。

タイプ: オブジェクト

Instances

オプション

ロードバランサーの EC2 インスタンスのリスト。

タイプ: オブジェクトの配列

ListenerDescriptions

オプション

ロードバランサーのリスナーで有効になっているポリシー。

タイプ: オブジェクトの配列

LoadBalancerAttributes

オプション

ロードバランサーの属性。

タイプ: オブジェクト

LoadBalancerName

オプション

ロードバランサーの名前。

タイプ: 文字列

Policies

オプション

ロードバランサーのポリシー。

タイプ: オブジェクト

Scheme

オプション

ロードバランサーのタイプ。ロードバランサーが VPC 内にある場合にのみ提供されます。

Schemeinternet-facing である場合、ロードバランサーのパブリック DNS 名はパブリック IP アドレスに解決されます。

Schemeinternal である場合、ロードバランサーのパブリック DNS 名はプライベート IP アドレスに解決されます。

タイプ: 文字列

有効な値: internet-facing | internal

SecurityGroups

オプション

ロードバランサーのセキュリティグループ。ロードバランサーが VPC 内にある場合にのみ提供されます。

タイプ: 文字列の配列

SourceSecurityGroup

オプション

ロードバランサーのセキュリティグループに関する情報。これは、インバウンドルールに使用されるセキュリティグループです。

タイプ: オブジェクト

Subnets

オプション

ロードバランサーのサブネット識別子のリスト。

タイプ: 文字列の配列

VpcId

オプション

ロードバランサーの VPC の識別子。

タイプ: 文字列

BackendServerDescriptions

-BackendServerDescriptionsオブジェクトは、ロードバランサーの EC2 インスタンスについて、設定に関する情報を提供します。

EC2 インスタンスごとに、BackendServerDescriptionsには、以下の属性を含めることができます。

InstancePort

オプション

EC2 インスタンスがリッスンするポート。

タイプ: 数値

PolicyNames

オプション

EC2 インスタンスで有効になっているポリシーの名前。

タイプ: 文字列の配列

HealthCheck

-HealthCheckオブジェクトには、ロードバランサーで実行されるヘルスチェックに関する情報が含まれます。

HealthCheck には、以下の属性を含めることができます。

HealthyThreshold

オプション

ヘルスチェックが連続して何回成功したらインスタンスが Healthy 状態になるか。

タイプ: 数値

最小値はです。 2

値の最大長 10

Interval

オプション

各インスタンスのヘルスチェックのおおよその間隔 (秒)。

タイプ:number

最小値はです。 5

値の最大長 300

Target

オプション

チェックするインスタンス。ターゲットは、プロトコルとポートを指定します。使用可能なプロトコルは、TCP、SSL、HTTP、および HTTPS です。有効なポートの範囲は 1~65535 です。

HTTP プロトコルと HTTPS プロトコルの場合、ターゲットは ping パスも指定します。

TCP プロトコルの場合、ターゲットはTCP: <port>

SSL プロトコルの場合、ターゲットはSSL.<port>

HTTP プロトコルと HTTPS プロトコルの場合、ターゲットは<protocol>:<port>/<path to ping>

タイプ: 文字列

最大長: 1,024

: HTTP:80/png

Timeout

オプション

秒単位の時間で、レスポンスがない状態がこの時間を超えると、ヘルスチェックが失敗と見なされます。

タイプ: 数値

最小値はです。 2

値の最大長 60

UnhealthyThreshold

オプション

ヘルスチェックが連続して何度失敗したらインスタンスを異常状態とするか。

タイプ: 数値

最小値はです。 2

値の最大長 10

Instances

-Instancesオブジェクトには、ロードバランサーの EC2 インスタンスのリストが含まれます。

各 EC2 インスタンスは、次の属性を含めることができます。

InstanceId

オプション

インスタンス識別子

タイプ: 文字列

ListenerDescriptions

-ListenerDescriptionsオブジェクトには、ロードバランサーのリスナーに対して有効になっているポリシーが一覧表示されます。

ListenerDescriptions には、以下の属性を含めることができます。

Listener

オプション

リスナーに関する情報。

タイプ: オブジェクト

PolicyNames

オプション

リスナーに対して有効になっているポリシー。

タイプ: 文字列の配列

-Listenerオブジェクトには、リスナーに関する情報が含まれています。

Listener には、以下の属性を含めることができます。

InstancePort

オプション

インスタンスがリッスンするポート。

タイプ: 数値

最小値はです。 1

値の最大長 65,535

InstanceProtocol

オプション

トラフィックをインスタンスにルーティングするために使用するプロトコル。

タイプ: 文字列

有効な値: HTTP|HTTPS|TCP|SSL

LoadBalancerPort

オプション

ロードバランサーがリッスンするポート。

EC2-VPC では、1〜65535 の範囲の任意のポートを指定できます。

EC2-Classic では、次のリストから任意のポートを指定できます。25、80、443、465、587、1024~65535。

タイプ: 数値

Protocol

オプション

ルーティングに使用するロードバランサーのトランスポートプロトコル。

タイプ: 文字列

有効な値: HTTP|HTTPS|TCP|SSL

SslCertificateId

オプション

サーバー証明書の ARN。

タイプ: 文字列

LoadBalancerAttributes

-LoadBalancerAttributesオブジェクトには、ロードバランサーの属性が含まれます。

LoadBalancerAttributes には、以下の属性を含めることができます。

AccessLog

オプション

ロードバランサーのアクセスログ設定に関する情報。

アクセスログが有効になっている場合、ロードバランサーはすべてのリクエストに関する詳細情報をキャプチャします。指定された S3 バケットに情報を配信します。

タイプ: オブジェクト

ConnectionDraining

オプション

ロードバランサーの接続ドレイン設定に関する情報。

接続のストリーミングが有効な場合、ロードバランサーは、登録解除されたインスタンスや異常なインスタンスからトラフィックを移動する前に、既存のリクエストを完了させることができます。

タイプ: オブジェクト

ConnectionSettings

オプション

ロードバランサーの接続設定。

アイドルタイムアウトが設定されている場合、ロードバランサーは、指定された期間、接続をアイドル状態にしたままにします。接続がアイドル状態のときは、その接続を介してデータは送信されません。

タイプ: オブジェクト

CrossZoneLoadBalancing

オプション

ロードバランサーのクロスゾーン負荷分散設定。

クロスゾーンの負荷分散が有効な場合、ロードバランサーは、アベイラビリティゾーンに関係なく、リクエストトラフィックをすべてのインスタンスに均等にルーティングします。

タイプ: オブジェクト

-AccessLogオブジェクトには、ロードバランサーのアクセスログ設定に関する情報が含まれています。

AccessLog には、以下の属性を含めることができます。

EmitInterval

オプション

アクセスログを発行する間隔 (分)。

アクセスログは、5 分ごとまたは 60 分ごとに公開できます。

タイプ: 数値

有効な値: 5 | 60

Enabled

オプション

ロードバランサーでアクセスログが有効かどうかを示します。

タイプ: ブール値

S3BucketName

オプション

アクセスログが保存されている S3 バケットの名前。

タイプ: 文字列

S3BucketPrefix

オプション

S3 バケット用に作成された論理階層。

プレフィックスが指定されていない場合、ログはバケットのルートレベルに配置されます。

タイプ: 文字列

-ConnectionDrainingオブジェクトには、ロードバランサーの Connection Draining 設定に関する情報が含まれます。

ConnectionDraining には、以下の属性を含めることができます。

Enabled

オプション

ロードバランサーに対して Connection Draining を有効にするかどうかを指定します。

タイプ: ブール値

Timeout

オプション

既存の接続を開いたままにする最大時間 (秒単位)。この最大時間を超えると、インスタンスの登録が解除されます。

タイプ: 数値

-ConnectionSettingsオブジェクトには、ロードバランサーの接続設定が含まれています。

ConnectionSettings には、以下の属性を含めることができます。

IdleTimeout

オプション

接続がアイドル状態 (接続を介してデータが送信されない状態) になるまでの時間 (秒単位)。秒単位 (秒単位)。この時間を超えると、ロードバランサーによって接続が閉じられます。

タイプ: 数値

-CrossZoneLoadBalancingオブジェクトには、ロードバランサーのクロスゾーン負荷分散設定が含まれています。

CrossZoneLoadBalancing には、以下の属性を含めることができます。

Enabled

オプション

ロードバランサーでクロスゾーン負荷分散が有効かどうかを示します。

タイプ: ブール値

Policies

-Policiesオブジェクトには、ロードバランサーのポリシーに関する情報が含まれています。

Policies には、以下の属性を含めることができます。

AppCookieStickinessPolicies

オプション

を使用して作成されるスティッキネスポリシーCreateAppCookieStickinessPolicy

タイプ: オブジェクトの配列

LbCookieStickinessPolicies

オプション

を使用して作成されるスティッキネスポリシーCreateLBCookieStickinessPolicy

タイプ: オブジェクトの配列

OtherPolicies

オプション

スティッキネスポリシー以外のポリシー。

タイプ: 文字列の配列

-AppCookieStickinessPoliciesオブジェクトには、CreateAppCookieStickinessPolicy

各ポリシーには、次の属性を含めることができます。

CookieName

オプション

セッション維持に使用するアプリケーション Cookie の名前。

タイプ: 文字列

PolicyName

オプション

作成中のポリシーのニーモニック名。名前は、ロードバランサーのポリシーのセット内で一意である必要があります。

タイプ: 文字列

-LbCookieStickinessPoliciesオブジェクトには、を使用して作成されたスティッキネスポリシーに関する情報が含まれています。CreateLBCookieStickinessPolicy

各ポリシーには、次の属性を含めることができます。

CookieExpirationPeriod

オプション

Cookie が古くなったと判断されるまでの時間 (秒単位)。有効期限を指定しなかった場合、維持セッションはブラウザセッションが終わるまで保持されます。

タイプ: 数値

PolicyName

オプション

ポリシーの名前。名前は、ロードバランサーのポリシーのセット内で一意である必要があります。

タイプ: 文字列

SourceSecurityGroup

-SourceSecurityGroupオブジェクトには、ロードバランサーのセキュリティグループに関する情報が含まれています。

SourceSecurityGroup には、以下の属性を含めることができます。

GroupName

オプション

セキュリティグループの名前。

タイプ: 文字列

OwnerAlias

オプション

セキュリティグループの所有者。

タイプ: 文字列

AwsElbv2LoadBalancer

AwsElbv2LoadBalancer オブジェクトは、ロードバランサーに関する情報を提供します。

これには、次の属性を含めることができます。

AvailabilityZones

オプション

ロードバランサーのアベイラビリティゾーン。

タイプ: オブジェクト

CanonicalHostedZoneId

オプション

ロードバランサーに関連付けられる Amazon Route 53 ホストゾーンの ID。

タイプ: 文字列

CreatedTime

オプション

ロードバランサーが作成された日時を示します。

タイプ: 文字列

形式: の使用date-timeで指定されている形式RFC 3339 セクション 5.6、インターネット日付/時刻形式。値にスペースを含めることはできません。

DNSName

オプション

ロードバランサーのパブリック DNS 名。

タイプ: 文字列

IpAddressType

オプション

ロードバランサーのサブネットで使用される IP アドレスのタイプ。

指定できる値は、ipv4 (IPv4 アドレスの場合) または dualstack (IPv4 および IPv6 アドレスの場合) です。

タイプ: 文字列

Scheme

オプション

インターネット向けロードバランサーのノードにはパブリック IP アドレスが必要です。

タイプ: 文字列

SecurityGroups

オプション

ロードバランサーのセキュリティグループの ID。

タイプ: 文字列の配列

State

オプション

ロードバランサーの状態。

タイプ: オブジェクト

Type

オプション

ロードバランサーのタイプ。

タイプ: 文字列

VpcId

オプション

ロードバランサーの VPC の ID。

タイプ: 文字列

AvailabilityZones

ロードバランサーのアベイラビリティーゾーンを指定します。

各アベイラビリティーゾーンには、次の属性を含めることができます。

SubnetId

オプション

サブネットの ID。

タイプ: 文字列

ZoneName

オプション

アベイラビリティーゾーンの名前。

タイプ: 文字列