ASFF 属性 - Amazon Security Hub
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

ASFF 属性

下表列出了AmazonSecurity Fin 格式 (ASFF)。要查看对象的属性和结构的详细信息,请选择对象名称。

必需的属性

所有结果都需要以下属性。

AwsAccountId

必需

应用查找结果的 Amazon 账户 ID。

类型: 字符串

最大长度:12 位数字

示例

"AwsAccountId": "111111111111"
CreatedAt

必需

指示何时创建查找结果捕获的潜在安全问题。

这些区域有:CreatedAt时间戳反映了创建查找记录的时间。因此,它可以不同于FirstObservedAt时间戳,该属性反映的是首次观察到事件或漏洞的时间。

该时间戳必须在第一代结果中提供,并且不能在随后更新结果时更改。

类型: 字符串

格式: 使用date-time中指定的格式RFC 3339 第 5.6 节,互联网日期/时间格式。值不能含有空格。

示例

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

结果将在最近更新后 90 天或创建后 90 天(如果未发生更新)后删除。要将结果存储 90 天以上,您可以在 Amazon EventBridge 中配置将结果路由到 S3 存储桶的规则。

Description

必需

结果说明。该字段可以是非特定的样板文本,也可以是特定于结果实例的详细信息。

类型: 字符串

最大长度: 1024

示例

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

必需

生成结果的特定于解决方案的组件(离散的逻辑单元)的标识符。在安全结果产品提供的各种解决方案中,该生成器可以称为规则、检查、检测器、插件等。

类型: string 字符串或 ARN

最大长度: 512

示例

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

必需

结果的特定于产品的标识符。

类型: string 字符串或 ARN

最大长度:512 表示字符串值,2048 表示 ARN 值

结果 ID 必须遵守以下限制:

  • ID 在产品中必须保持全局唯一。要强制实现唯一性,您可以将公共 Amazon 区域名称和账户 ID 合并到该标识符中。

  • 无论以前的结果是否不再存在,您都无法 回收标识符。

  • 对于以外的服务Amazon,ID不能前缀为文字字符串”arn:“。

  • 对于 Amazon 服务,ID 必须 为结果的 ARN(如果有)。否则,您可以使用任何其他唯一标识符。

预计上述限制仅适用于单一结果产品,不覆盖多个结果产品。

示例

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

必需

Security Hub 生成的 ARN,用于在产品注册到 Security Hub 后唯一地标识第三方结果产品。

类型: ARN

此字段的格式为 arn:partition:securityhub:region:account-id:product/company-id/product-id

  • 适用于Amazon与 Security Hub 集成的服务、company-id必须是”aws”,以及product-id必须为Amazon公共服务名称。由于Amazon产品和服务未与帐户关联,account-id部 ARN 空。Amazon尚未与 Security Hub 集成的服务被视为第三方产品。

  • 对于公共产品,company-idproduct-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

必需

格式化结果的架构版本。该字段的值必须为 Amazon 确定的官方发布版本之一。

在当前版本中,Amazon Security Finding 格式架构版本为 2018-10-08

类型: 字符串

最大长度: 10

Format: 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 格式的结果类型,用于对结果进行分类。

Types应该只使用进行更新BatchUpdateFindings

查找想要提供的值的提供者Types应使用Types属性FindingProviderFields。请参阅 使用 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时间戳,该属性反映的是上次或最近一次观察到事件或漏洞的时间。

更新结果记录时,必须将该时间戳更新为当前时间戳。在创建结果记录时,CreatedAtUpdatedAt时间戳必须相同。更新结果记录后,该字段的值必须大于其包含的所有先前值。

请注意,UpdatedAt 不会由 BatchUpdateFindings 中的更改进行更新。它只由 BatchImportFindings 进行更新。

结果将在最近更新后 90 天或创建后 90 天(如果未发生更新)后删除。要将结果存储 90 天以上,您可以在 CloudWatch 事件中配置将结果路由到 Amazon S3 存储桶的规则。

类型: 字符串

格式: 使用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应使用Confidence属性FindingProviderFields。请参阅 使用 FindingProviderFields

类型: 整数

最小值: 0

最大值: 100

使用比例刻度对置信度进行评分 (0-100),0 表示置信度为 0%,100 表示置信度为 100%。

但是,基于网络流量的统计偏差的数据泄漏检测具有低得多的置信度 - 因为尚未验证实际的泄漏。

示例

"Confidence": 42
Criticality

可选

分配给与结果关联的资源的重要性级别。评分为 0 意味着底层资源不关键,对于最关键的资源,评分为 100。

Criticality应该只能通过BatchUpdateFindings。它不应该通过BatchImportFindings

查找想要提供的值的提供者Criticality应使用Criticality属性FindingProviderFields。请参阅 使用 FindingProviderFields

类型: 整数

最小值: 0

最大值: 100

使用仅支持全整型的比例刻度,在 0-100 的范围内对严重性评分。评分为 0 意味着底层资源不关键,对于最关键的资源,评分为 100。

概括来说,评估临界性时,您需要考虑以下事项:

  • 哪些调查结果影响比其他资源更重要的资源?

  • 与其他资源相比,这些资源在多大程度上更重要?

对于每个资源,请考虑以下事项:

  • 受影响的资源是否包含敏感数据(例如,包含 PII 的 S3 存储桶)?

  • 受影响的资源是否使攻击者能够提升访问权限或提高执行其他恶意活动的能力(例如,泄露的 sysadmin 账户)?

  • 资源是否为业务关键型资产(例如,在受到攻击时可能会对收入造成重大影响的关键业务系统)?

您可以使用以下准则:

  • 对于支持关键任务型系统或包含高度敏感数据的资源,评分范围为 75—100。

  • 对于支持重要(但非关键)系统或包含中等重要程度数据的资源,评分范围为 25—75。

  • 对于支持不重要系统或包含非敏感数据的资源,评分范围应为 0—24。

示例

"Criticality": 99
FindingProviderFields

可选

InBatchImportFindings请求,查找提供程序使用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

可选

一种数据类型,其中安全结果产品可以包含不属于已定义的AmazonSecurity Fine 格式。

对于 Security Hub 控件生成的调查结果,ProductFields包含有关控件的信息。请参阅 生成和更新控制结果

类型: 键/值对映射

最大配对数: 50

最大密钥长度: 128

最大值长度: 2048

该字段不应包含冗余数据,并且不能包含与 Amazon Security Finding 格式字段冲突的数据。

aws/”前缀仅代表 Amazon 产品和服务的保留命名空间,不得与来自合作伙伴产品的结果一起提交。

虽然不是必需的,但产品应将字段名称格式化为 company-id/product-id/field-name,其中 company-idproduct-id 与结果的 ProductArn 中提供的名称匹配。

字段名称可能包含以下字符:以下字符:A-Z、a-z、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 状态表示应从视图中隐藏结果。已存档的查找结果不会立即删除。您可以搜索、查看和报告这些结果。

RecordState旨在查找提供商,并且只能由BatchImportFindings。它无法使用进行更新BatchUpdateFindings

要跟踪调查结果的状态,请勿使用RecordState。请改用 Workflow

查找提供程序会更新记录状态。如果删除关联的资源、资源不存在或禁用控件,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字段,表示未映射到任何标准AmazonSecurity Fisfinity Fondis

这些字段只能使用 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 地址发出AmazonAPI 调用。

  • 已收到 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

可选

在Amazon该 API 调用所属的服务。

类型: 字符串

DomainDetails

DomainDetails提供AwsApiCallAction.CallerTypedomain。它提供了有关发出 API 调用的 DNS 域的信息。

DomainDetails 可能具有以下属性。

Domain

可选

发出 API 调用的 DNS 域的名称。

类型: 字符串

DnsRequestAction

DnsRequestAction提供ActionTypeDNS_REQUEST。它提供了有关检测到的 DNS 请求的详细信息。

DnsRequestAction 可能具有以下属性。

Blocked

可选

指示是否阻止 DNS 请求。

类型: Boolean

Domain

可选

与 DNS 请求关联的 DNS 域。

类型: 字符串

Protocol

可选

DNS 请求使用的协议。

类型: 字符串

NetworkConnectionAction

NetworkConnectionAction提供ActionTypeNETWORK_CONNECTION。它提供了有关检测到的尝试网络连接的详细信息。

NetworkConnectionAction 可能具有以下属性。

Blocked

可选

指示是否阻止了网络连接尝试。

类型: Boolean

ConnectionDirection

可选

网络连接请求的方向。

类型: 字符串

有效值IN | OUT

LocalPortDetails

可选

有关 EC2 实例上的端口的信息。

类型: 对象

Protocol

可选

用于发出网络连接请求的协议。

类型: 字符串

RemoteIpDetails

可选

发出网络连接请求的远程 IP 地址的信息。

类型: 对象

RemotePortDetails

可选

远程 IP 地址上的端口信息。

类型: 对象

RemotePortDetails

RemotePortDetails提供了有关尝试网络连接中涉及的远程端口的信息。

RemotePortDetails 可能具有以下属性。

Port

可选

端口的编号。

类型: 整数

PortName

可选

远程连接的端口名称。

类型: 字符串

PortProbeAction

PortProbeAction提供ActionTypePORT_PROBE。它提供了有关检测到的尝试端口探测的详细信息。

PortProbeAction 可能具有以下属性。

Blocked

可选

端口探测器是否被阻塞。

类型: Boolean

PortProbeDetails

可选

有关受端口探测影响的端口的信息。

类型: 对象数组

PortProbeDetails

PortProbeDetails包含作为端口探测一部分的端口扫描列表。对于每次扫描,PortProbeDetails提供有关扫描的本地 IP 地址和端口以及扫描源自的远程 IP 地址的信息。

PortProbeDetails 可能具有以下属性。

LocalIpDetails

可选

提供有关扫描端口所在 IP 地址的信息。

类型: 对象

LocalPortDetails

可选

提供有关扫描的端口的信息。

类型: 对象

RemoteIpDetails

可选

提供有关执行扫描的远程 IP 地址的信息。

类型: 对象

LocalIpDetails 可能具有以下属性。

IpAddressV4

可选

IP 地址。

类型: 字符串

LocalPortDetails

适用于NetworkConnectionActionPortProbeDetailsLocalPortDetails提供了有关操作中涉及的本地端口的信息。

LocalPortDetails 可能具有以下属性。

Port

可选

端口的编号。

类型: 整数

PortName

可选

本地连接的端口名称。

类型: 字符串

RemoteIpDetails

在详细信息AwsApiCallActionNetworkConnectionAction, 和PortProbeActionRemoteIpDetails对象提供了有关操作中涉及的远程 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 地址的 Internet 提供商的自治系统编号 (ASN)。

类型: 字符串

AsnOrg

可选

注册 ASN 的组织的名称。

类型: 字符串

Isp

可选

Internet 提供商的 ISP 信息。

类型: 字符串

Org

可选

Internet 提供商的名称。

类型: 字符串

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对于从发现变化PASSEDFAILEDWARNING,或者NOT_AVAILABLE, 和Workflow.Status或者是NOTIFIED或者RESOLVED,则 Security Hub 会自动设置Workflow.StatusNEW

  • WARNING— 某些信息缺失或您的配置不支持此检查。

  • FAILED— 至少有一个评估的资源未能通过安全检查。

  • NOT_AVAILABLE— 由于服务中断或 API 错误,无法执行检查。NOT_AVAILABLE 状态还可能表示 Amazon Config 评估结果为 NOT_APPLICABLE。在这种情况下,在 3 天后自 Security Hub 将结果存档。

示例

"Status": "PASSED"
StatusReasons

可选

对于从控制生成的结果,Compliance.Status 值背后的原因列表。

有关状态代码及其含义的列表,请参阅 生成和更新控制结果

类型: 字符串

示例:

"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来提供LabelOriginal

有关可用值的详细信息LabelOriginal,以及有关如何评估严重性的指南,请参阅Severity对象

类型: 对象

Types

必需

一个或多个格式的结果类型,名称空间/分类/分类器对调查结果进行分类。

类型: 字符串数组

字符串的最大数量: 50

Malware

这些区域有:Malware对象提供与结果相关的恶意软件列表。它是一个数组,最多可以包含五个恶意软件对象。

示例

"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

最大值: 100000

Id

必需

用于确定修补程序合规性状态的符合性标准的标识符。

类型: 字符串

最小长度: 20

最大长度: 128

InstalledCount

可选

成功安装的符合性标准中的修补程序数。

类型: 数字

最小值: 0

最大值: 100000

InstalledOtherCount

可选

不属于合规性标准的已安装修补程序的数量。

类型: 数字

最小值: 0

最大值: 100000

InstalledPendingReboot

可选

已应用但需要重新引导实例才能标记为已安装的修补程序数。

类型: 数字

最小值: 0

最大值: 100000

InstalledRejectedCount

可选

已安装但也位于客户拒绝的修补程序列表中的修补程序数。

类型: 数字

最小值: 0

最大值: 100000

MissingCount

可选

属于合规性标准但未安装的修补程序的数量。计数包括安装失败的修补程序。

类型: 数字

最小值: 0

最大值: 100000

Operation

可选

执行的修补程序操作的类型。

对于修补程序管理器,值为SCANINSTALL

类型: 字符串

最大长度: 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 字段旨在方便提供手动指令或详细信息,以帮助解决结果中发现的问题。

如果建议对象存在,则 TextUrl 字段必须存在并填写了该字段。这两个字段可以同时存在,并填写了这些字段。

类型: 对象

示例

"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 不得要求提供凭证才能访问。它必须可从公有 Internet 访问,不得提出任何上下文或会话要求。

类型: 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

可选

此字段提供了有关使用相应对象的单个资源的其他详细信息。

请注意,如果查找结果大小超过 240 KB 的最大值,则Details对象从查找结果中删除。对于使用Amazon Config规则,您可以在Amazon Config控制台。

每个资源都必须在Resources对象。

Security Hub 为支持的资源类型提供了一组可用的对象。这些对象对应于资源的值Type。使用提供的类型和对象(如果可能)。

例如,如果资源是 S3 存储桶,则将资源TypeAwsS3Bucket,并在AwsS3Bucket子字段。

Other 子字段允许您提供自定义字段和值。在以下情况下,可以使用 Other 子字段。

  • 资源类型(资源 Type 的值)没有相应的子字段。要提供资源的详细信息,请使用 Other 详细信息子字段。

  • 资源类型的子字段不包含要填充的所有字段。在此情况下,可使用资源类型的子字段来填充可用字段。使用 Other 子字段填充未在特定于类型的子字段中的字段。

  • 资源类型不是提供的类型之一。在这种情况下,请将资源 Type 设置为 Other,并使用 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 标识的 Amazon 资源,这必须是 ARN。

对于缺少 ARN 的所有其他 Amazon 资源类型,这必须是创建该资源的 Amazon 服务定义的标识符。

对于无Amazon资源,这应该是与资源关联的唯一标识符。

类型: string 字符串或 ARN

最大长度: 512

示例

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

可选

区域分配到的规范 Amazon 分区名称。

类型: 枚举

有效值:

分区

描述

aws

所有其他区域

aws-cn

中国

aws-us-gov

Amazon GovCloud (US)

示例

"Partition": "aws"
Region

可选

该资源所在的规范 Amazon 外部区域名称。

类型: 字符串

最大长度: 16

示例

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

可选

标识资源在查找结果中的角色。资源是查找活动的目标或执行该活动的参与者。

类型: 字符串

有效值Actor | Target

Tags

可选

在处理结果时,与资源关联的 Amazon 标签的列表。仅为具有关联的标签的资源包含 Tags 属性。如果资源没有关联的标签,请不要在结果中包含 Tags 属性。

类型: 标签映射

最大标签数: 50

每个值的最大长度: 256

下面是适用于标签的基本限制:

  • 您只能在该字段中提供 Amazon 资源上实际存在的标签。要为 Amazon Security Finding 格式中未定义的资源类型提供数据,请使用 Other 详细信息子字段。

  • 值仅限于以下字符:A-Z、a-z、0-9、空格和.:+ = @ _/-(连字符)。

  • 值仅限于Amazon最大长度为 256 个字符的标签值。

示例

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

必需

要为其提供详细信息的资源的类型。

如果可能,使用提供的资源类型之一,例如 AwsEc2InstanceAwsS3Bucket

如果资源类型与提供的任何资源类型不匹配,则将资源TypeOther,然后使用Other详细信息子字段填充详细信息。

类型: 字符串

最大长度: 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

可选

指示是否存在未包含在查找结果中的敏感数据的其他匹配项。当发生次数超过可包含的最大值时,就会发生这种情况。

类型: Boolean

CustomDataIdentifiers

可选

提供有关根据客户定义的配置标识的敏感数据的详细信息。

类型: 对象

MimeType

可选

应用查找结果的内容类型。

类型: 字符串

所需格式: 必须是 MIME 类型。

示例

  • application/gzip,用于 GNU Gzip 压缩的归档文件

  • application/pdf,用于 Adobe 可移植文档格式 (.pdf) 文件

SensitiveData

可选

提供有关基于内置配置识别的敏感数据的详细信息。

类型: 对象

SizeClassified

可选

受影响数据的总大小 (以字节为单位)。

类型: 长整型

Status

可选

提供有关检测当前状态的详细信息。

类型: 对象

Status.Code

可选

表示敏感数据检测状态的代码。

类型: 字符串

Status.Reason

可选

详细描述敏感数据检测的当前状态。

类型: 字符串

CustomDataIdentifiers

CustomDataIdentifiers包含由用户定义的标识符检测到的敏感数据的实例。

CustomDataIdentifiers 可能具有以下属性。

Detections

可选

检测到的敏感数据实例的列表。

类型: 对象数组

TotalCount

可选

敏感数据的出现总数。

类型: 整数

SensitiveData

SensitiveData包含检测到的基于内置标识符的敏感数据实例。

Category

可选

检测到的敏感数据的类别。例如,该类别可能表明敏感数据涉及凭据、财务信息或个人信息。

类型: 字符串

Detections

可选

检测到的敏感数据实例的列表。

类型: 对象数组

TotalCount

可选

敏感数据的出现总数。

类型: 整数

Detections

Detections包含检测到的敏感数据的详细信息。

每个检测到的敏感数据的实例可能具有以下属性。

Arn

可选

用于检测敏感数据的自定义标识符的 ARN。

Arn仅在Detections实例CustomDataIdentifiersDetections实例SensitiveData没有Arn属性。

类型: 字符串

Count

可选

检测到的敏感数据的总出现次数。

类型: 整数

Name

可选

检测到敏感数据的自定义标识符的名称。

Name仅在Detections实例CustomDataIdentifiersDetections实例SensitiveData没有Name属性。

类型: 字符串

Occurrences

可选

有关检测到的敏感数据的详细信息。Occurrences可能包含以下对象。每个对象都包含一个对象数组。

  • Cells— 包含在 Microsoft Excel 文件中检测到的敏感数据的出现次数,逗号分隔值 (.csv) 文件或制表符分隔的值 (.tsv) 文件

  • LineRanges— 包含在非二进制文本文件或微软 Word 文件

  • OffsetRanges— 包含在二进制文本文件中检测到的敏感数据的出现

  • Pages— 包含以 Adobe 可移植文档格式检测到的敏感数据的出现次数 (.pdf) 文件

  • Records— 包含在 Apache Avro 对象容器或 Apache 镶木地板文件中检测到的敏感数据的出现

类型: 对象

Type

可选

检测到的敏感数据的类型。例如,类型可能指示数据是电子邮件地址。

Type仅在Detections实例SensitiveDataDetections实例CustomDataIdentifiers没有Type属性。

类型: 字符串

Cells

Cells包含在 Microsoft Excel 工作簿中检测到的敏感数据,逗号分隔值 (.csv) 文件或制表符分隔的值 (.tsv) 文件。

对于每次出现的情况,Cells标识包含敏感数据的单元格。

每个匹配项可能包含以下属性。

CellReference

可选

对于 Microsoft Excel 工作簿,提供包含数据的单元格绝对引用的单元格的位置。例如,表 2! 表 2 上的 C5 单元格 C5。

此属性为空.csv.tsv文件。

类型: 字符串

Column

可选

包含数据的列的列号。对于 Microsoft Excel 工作簿,列号对应于按字母顺序排列的列标识符。例如,值表示 1Column对应于工作簿中的 A 列。

类型: 整数

ColumnName

可选

包含数据的列的名称。

类型: 字符串

Row

可选

包含数据的行的行号。

类型: 整数

LineRanges

LineRanges包含在非二进制文本文件或 Microsoft Word 文件中检测到的敏感数据的匹配项。非二进制文本文件包括.html.xml.json, 和.txt文件。

对于每次出现的情况,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 镶木地板文件中敏感数据的出现情况。

对于每次出现的情况,Records指定记录索引和包含敏感数据的字段的路径。

每个匹配项可能具有以下属性。

JsonPath

可选

包含数据的记录中字段的路径(作为 JSONPath 表达式)。如果字段名超过 20 个字符,则将被截断。如果路径长度超过 250 个字符,则将被截断。

类型: 字符串

RecordIndex

可选

包含数据的记录的记录索引(从 0 开始)。

类型: 整数

AwsApiGatewayRestApi

这些区域有:AwsApiGatewayRestApi对象包含有关 Amazon API Gateway 版本 1 中的 REST API 的信息。

示例

AwsApiGatewayRestApi: { "Id": "exampleapi", "Name": "Security Hub", "Description": "Amazon 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 密钥标头读取 API 密钥。

AUTHORIZER指示是否从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 的版本标识符。

类型: 字符串

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

可选

指示是否为阶段启用缓存集群。

类型: Boolean

CacheClusterSize

可选

如果启用了缓存集群,则表示缓存集群的大小。

类型: 字符串

CacheClusterStatus

可选

如果启用了缓存集群,则表示缓存集群的状态。

类型: 字符串

CanarySettings

可选

有关在舞台中金丝雀部署设置的信息。

类型: 对象

ClientCertificateId

可选

阶段的客户端证书的标识符。

类型: 字符串

CreatedDate

可选

指示创建阶段的时间。

类型: 字符串

格式: 使用date-time中指定的格式RFC 3339 第 5.6 节,互联网日期/时间格式。值不能含有空格。

示例

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

可选

阶段指向的部署的标识符。

类型: 字符串

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

可选

指示使用Amazon X-Ray为阶段启用。

类型: Boolean

Variables

可选

一个定义阶段变量的映射。

变量名称可以包含以下字符:A-Z、a-z、0-9 和 _(下划线)。

变量值可能包含以下字符:

  • 大写字母和小写字母

  • 数字

  • 特殊字符。_ ~:/? # & =,-(连字符)

类型: 字符串的映射

WebAclArn

可选

与舞台关联的 Web 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

可选

金丝雀部署的部署标识符。

类型: 字符串

PercentTraffic

可选

转换到金丝雀部署的流量百分比。

类型: 数字

最小值: 0

最大值: 100

StageVariableOverrides

可选

在金丝雀发布部署中覆盖的阶段变量。这些变量包括在金丝雀中引入的新阶段变量。

每个变量都表示为阶段变量名称和变量值之间的字符串到字符串映射。

"variableName" : "variableValue"

类型: 对象

UseStageCache

可选

指示金丝雀部署是否使用阶段缓存。

类型: Boolean

MethodSettings

这些区域有:MethodSettings对象定义阶段的方法设置。

中的每个方法对象MethodSettings可能具有以下属性。

CacheDataEncrypted

可选

指示是否加密缓存的响应。

类型: Boolean

CachingEnabled

可选

指示是为请求缓存还是返回响应。要缓存响应,必须在舞台上启用缓存集群。

类型: Boolean

CacheTtlInSeconds

可选

指定缓存响应的存续时间 (TTL),以秒计算。TTL 越高,响应缓存的时间越长。

类型: 数字

DataTraceEnabled

可选

指示是否为该方法启用数据跟踪日志记录。数据跟踪日志记录会影响推送到 CloudWatch Logs 条目。

类型: Boolean

HttpMethod

可选

HTTP 方法。您可以将星号 (*) 作为通配符以将方法设置应用于多个方法。

类型: 字符串

LoggingLevel

可选

此方法的日志记录级别。日志记录级别会影响推送到 CloudWatch Logs 条目。

如果日志记录级别为ERROR,则日志仅包含错误级别的条目。

如果日志记录级别为INFO,那么日志包含ERROR事件和额外的信息性事件。

类型: 字符串

有效值OFF | ERROR | INFO

MetricsEnabled

可选

指示是否为该方法启用 CloudWatch 指标。

类型: Boolean

RequireAuthorizationForCacheControl

可选

指示缓存失效请求是否需要授权。

类型: Boolean

ResourcePath

可选

此方法的资源路径。正斜杠 (/) 编码为 ~1。初始斜杠必须包含正斜杠。

例如,路径值 /resource/subresource 必须编码为 /~1resource~1subresource

要指定根路径,请仅使用一个斜杠 (/)。您可以将星号 (*) 作为通配符以将方法设置应用于多个方法。

类型: 字符串

ThrottlingBurstLimit

可选

方法的限制突发限制。

类型: 数量 (i恩特格)

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。

类型: 字符串

Format: <api-id>.execute-api.<region>.amazonaws.com

阶段名称通常附加到 URI,以形成已部署 API 阶段的完整路径。

ApiId

可选

API 的标识符。

类型: 字符串

ApiKeySelectionExpression

可选

一个 API 键选择表达式。仅 WebSocket API 调用支持。

类型: 字符串

CorsConfiguration

可选

跨源资源共享 (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 的版本标识符。

类型: 字符串

CorsConfiguration

这些区域有:CorsConfiguration对象包含 API 的跨域资源共享 (CORS) 配置。CORS 仅 HTTP API 调用支持。

CorsConfiguration 可能具有以下属性。

AllowCredentials

可选

指示 CORS 请求是否包含凭据。

类型: Boolean

AllowHeaders

可选

CORS 请求允许的标头。

类型: 字符串数组

AllowMethods

可选

CORS 请求允许的方法。

类型: 字符串数组

AllowOrigins

可选

CORS 请求允许的来源。

类型: 字符串数组

ExposeHeaders

可选

CORS 请求的公开标头。

类型: 字符串数组

MaxAge

可选

浏览器缓存预检请求结果的秒数。

类型: 数字

AwsApiGatewayV2Stage

AwsApiGatewayV2Stage包含有关 Amazon 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 管理。

类型: Boolean

AutoDeploy

可选

指示对 API 的更新是否自动触发新的部署。

类型: Boolean

ClientCertificateId

可选

阶段的客户端证书的标识符。仅 WebSocket API 调用支持。

类型: 字符串

CreatedDate

可选

指示创建阶段的时间。

类型: 字符串

格式: 使用date-time中指定的格式RFC 3339 第 5.6 节,互联网日期/时间格式。值不能含有空格。

示例

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

可选

阶段的默认路由设置。

类型: 对象

DeploymentId

可选

该阶段关联到的部署的标识符。

类型: 字符串

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 和 _(下划线)。

类型: string 字符串的映射

有效值:

  • 大写字母和小写字母

  • 数字

  • 特殊字符。_ ~:/? # & =,-(连字符)

AccessLogSettings

这些区域有:AccessLogSettings对象包含有关阶段日志记录访问的设置的信息。

AccessLogSettings 可能具有以下属性。

DestinationArn

可选

接收访问日志的 CloudWatch Logs 日志组的 ARN。

类型: 字符串

Format

可选

数据访问日志的单行格式,由选定的$context变量。格式必须至少包括 $context.requestId

类型: 字符串

DefaultRouteSettings 和 RouteSettings

这些区域有:DefaultRouteSettings对象包含阶段的默认路由设置。

这些区域有:RouteSettings对象包含阶段的路由设置。

这些对象可能具有以下属性。

DataTraceEnabled

可选

指示是否启用数据跟踪日志记录。数据跟踪日志记录会影响推送到 CloudWatch Logs 条目。仅 WebSocket API 调用支持。

类型: Boolean

DetailedMetricsEnabled

可选

指示是否启用详细指标。

类型: Boolean

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对象提供有关Amazon 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

可选

受证书保护的完全限定域名 (FQDN),例如 www.example.com。

类型: 字符串

最小长度: 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

可选

的 ARN 的列表Amazon资源。

类型: 字符串数组

IssuedAt

可选

指示颁发证书的时间。如果证书类型为AMAZON_ISSUED

类型: 字符串

格式: 使用date-time中指定的格式RFC 3339 第 5.6 节,互联网日期/时间格式。值不能含有空格。

示例

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

可选

颁发和签署证书的证书颁发机构的名称。

类型: 字符串

KeyAlgorithm

可选

用于生成公有-私有 key pair 的算法。

类型: 字符串

有效值: 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

可选

证书中包含的一个或多个域名(使用者备用名称)。此列表包含绑定到证书中包含的公有密钥的域名。

主题备选名称包括证书的规范域名 (CN) 以及可用于连接到网站的其他域名。

类型: 字符串数组

最少的项数: 1

最大项数: 100

每件商品的最小长度: 1

每件商品的最大长度: 253

Type

可选

证书的来源。对于 ACM 提供的证书,TypeAMAZON_ISSUED。对于使用ImportCertificateTypeIMPORTED

类型: 字符串

有效值IMPORTED | AMAZON_ISSUED | PRIVATE

DomainValidationOptions

这些区域有:DomainValidationOptions对象包含有关以下内容之一的信息:

  • 每个域名的初始验证是由于RequestCertificate请求

  • 验证证证书中每个域名(与 ACM 托管续订相关)

DomainValidationOptions 可能具有以下属性。

DomainName

可选

证书中的完全限定域名 (FQDN)。

类型: 字符串

ResourceRecord

可选

添加到 DNS 数据库以进行域验证的别名记录。

类型: 对象

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 而不是 http://www.example.com/product-description.html。

类型: 字符串

DomainName

可选

与分配对应的域名。

类型: 字符串

Etag

可选

实体标签是对象的哈希。

类型: 字符串

LastModifiedTime

可选

指示上次修改分配的时间。

类型: 字符串

格式: 使用date-time中指定的格式RFC 3339 第 5.6 节,互联网日期/时间格式。值不能含有空格。

Logging

可选

控制是否写入分发的访问日志的复杂类型。

类型: 对象

OriginGroups

可选

提供有关分配中原点组的信息。

类型: 对象

Origins

可选

包含此分配的源和源组信息的复杂类型。

类型: 字符串

Status

可选

表示分配的当前状态。

类型: 字符串

WebAclId

可选

指定要与该分配关联的 Amazon WAF Web ACL(如果有)的唯一标识符。

类型: 字符串

CacheBehaviors

这些区域有:CacheBehaviors对象提供有关分配缓存的信息。这些区域有:CacheBehaviors对象包含一个Items对象数组。这些区域有:Items对象表示缓存行为。

中的每个对象Items可能具有以下属性。

ViewerProtocolPolicy

可选

查看器可用于访问来源中的文件的协议。可以指定以下选项:

  • allow-all— 查看器可以使用 HTTP 或 HTTPS。

  • redirect-to-https— CloudFront 对 HTTP 请求作出响应,这些请求的 HTTP 状态代码为 301(永久移动)和 HTTPS URL。然后,查看器使用新 URL 重新提交。

  • https-only— CloudFront 以 HTTP 状态代码 403 (禁止) 响应 HTTP 请求。

类型: 字符串

有效值allow-all | https-only | redirect-to-https

DefaultCacheBehavior

这些区域有:DefaultCacheBehavior对象包含有关分配默认缓存配置的信息。

DefaultCacheBehavior 可能具有以下属性。

ViewerProtocolPolicy

可选

查看器可用于访问来源中的文件的协议。可以指定以下选项:

  • allow-all— 查看器可以使用 HTTP 或 HTTPS。

  • redirect-to-https— CloudFront 对 HTTP 请求作出响应,这些请求的 HTTP 状态代码为 301(永久移动)和 HTTPS URL。然后,查看器使用新 URL 重新提交。

  • https-only— CloudFront 以 HTTP 状态代码 403 (禁止) 响应 HTTP 请求。

类型: 字符串

有效值allow-all | https-only | redirect-to-https

Logging

Logging 对象提供有关分配日志记录的信息。

它可能具有以下属性。

Bucket

可选

在其中存储访问日志的 S3 存储桶。

类型: 字符串

Enabled

可选

您可以使用该字段启用或禁用所选的分配。

类型: Boolean

IncludeCookies

可选

指定是否希望 CloudFront 将 Cookie 包含在访问日志中。

类型: Boolean

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 日志终端节点在写入日志组时担任的角色的 ARN。

类型: 字符串

HasCustomEventSelectors

可选

指示跟踪是否具有自定义事件选择器。

类型: Boolean

HomeRegion

可选

创建跟踪的区域。

类型: 字符串

IncludeGlobalServiceEvents

可选

指示跟踪是否将来自全球服务(例如 IAM)的事件发布到日志文件。

类型: Boolean

IsMultiRegionTrail

可选

指示跟踪是仅适用于当前区域还是适用于所有区域。

类型: Boolean

IsOrganizationTrail

可选

是否为Amazon Organizations,或者仅用于当前Amazonaccount.

类型: Boolean

KmsKeyId

可选

这些区域有:Amazon KMS密钥 ID,用于加密日志。

类型: 字符串

LogFileValidationEnabled

可选

指示是否启用 CloudTrail 日志文件验证。

类型: Boolean

Name

可选

跟踪的名称。

类型: 字符串

S3BucketName

可选

发布日志文件的 S3 存储桶的名称。

类型: 字符串

最小长度: 3

最大长度: 63

S3KeyPrefix

可选

S3 key prefix。key prefix 添加在发布日志文件的 S3 存储桶的名称之后。

类型: 字符串

最大长度: 200

SnsTopicArn

可选

用于日志文件传输通知的 SNS 主题的 ARN。

类型: 字符串

SnsTopicName

可选

用于日志文件传输通知的 SNS 主题的名称。

类型: 字符串

最大长度: 255

TrailArn

可选

跟踪的 ARN。

类型: 字符串

AwsCodeBuildProject

AwsCodeBuildProject 对象提供有关 Amazon 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

可选

用于加密构建输出构件的 Amazon KMS 客户主密钥 (CMK)。

注意

如果您的服务角色具有一个跨账户 KMS 密钥的权限,则您可使用此密钥来加密构建输出构件。

您可以指定 CMK 的 ARN,也可以使用 alias/alias-name 格式指定 CMK 别名(如果可用)。

类型: 字符串

最小长度:1

Environment

可选

有关该构建项目的构建环境的信息。

类型: 对象

Name

可选

构建项目的名称。

类型: 字符串

最小长度: 2

最大长度: 255

模式: [A-Za-z0-9] [A-Za-z0-9\-_] {1,254}

ServiceRole

可选

允许 CodeBuild 与依赖项进行交互的 IAM 角色的 ARNAmazon服务代表Amazonaccount.

类型: 字符串

最小长度: 1

Source

可选

有关此构建项目的构建输入源代码的信息。

类型: 对象

VpcConfig

可选

有关 CodeBuild 访问的 VPC 配置的信息。

类型: 对象

Environment

Environment 对象提供有关构建项目的构建环境的信息。

它可能具有以下属性。

Certificate

可选

要用于此构建项目的证书。

类型: 字符串

ImagePullCredentialsType

可选

CodeBuild 用于在您的生成中拉取映像的凭证的类型。有两个有效值:

CODEBUILD指定 CodeBuild 使用其自己的凭证。这要求您修改您的 ECR 存储库策略以信任 CodeBuild 服务委托人。

SERVICE_ROLE指定 CodeBuild 使用您的生成项目的服务角色。

当您使用跨账户或专用镜像仓库镜像时,必须使用 SERVICE_ROLE 凭证。当您使用 CodeBuild 辅助映像时,必须使用CODEBUILD凭证。

类型: 字符串

有效值CODEBUILD | SERVICE_ROLE

RegistryCredential

可选

用于访问私有注册表的凭证。

类型: 对象

Type

必需

要用于相关构建的构建环境的类型。

类型: 字符串

有效值: WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER

RegistryCredentials 对象中的每个注册表凭证具有以下属性。

Credential

必需

使用 Amazon Secrets Manager 创建的凭证的 ARN 或名称。

注意

仅当凭证存在于您的当前凭证中时,才能使用凭证的名称。Amazon区域。

类型: 字符串

最小长度: 1

CredentialProvider

必需

创建访问私有 Docker 注册表凭证的服务。有效值, SECRETS_MANAGER,是为 SSecrets Manager。

类型: 字符串

有效值SECRETS_MANAGER

Source

Source 对象提供有关该构建项目的构建输入源代码的信息。

它可能具有以下属性。

GitCloneDepth

可选

有关构建项目的 Git 克隆深度的信息。

类型: 整数

最小值: 0

Location

可选

有关要生成的源代码的位置的信息。

类型: 字符串

有效值:

  • 对于在 Amazon CodePipeline 中的管道的源操作中指定的源代码设置,不应指定 location。如果指定此参数,CodePipeline 会将其忽略。这是因为 CodePipeline 使用管道的源操作中的设置而不是该值。

  • 对于Amazon 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 Enterprise 存储库中。

    NO_SOURCE‐项目没有输入源代码。

    S3-源代码位于 Amazon S3 输入存储桶中。

VpcConfig

这些区域有:VpcConfig对象提供有关 CodeBuild 访问的 VPC 配置的信息。

它可能具有以下属性。

SecurityGroupIds

可选

Amazon VPC 中的一个或多个安全组 ID 的列表。

类型: 字符串数组

数组成员: 最多 5 件商品

每件商品的最小长度: 1

Subnets

可选

Amazon VPC 中的一个或多个子网 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

可选

索引当前是否正在回填。

类型: Boolean

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

可选

在 DynamoDB 返回 ThrottlingException 之前,每秒使用的最大强一致性读取数。

类型: 数字

WriteCapacityUnits

可选

在 DynamoDB 返回 ThrottlingException 之前,每秒使用的最大写入数。

类型: 数字

Replicas

这些区域有:Replicas对象包含此表的副本列表。

每个复制副本可能具有以下属性。

GlobalSecondaryIndexes

可选

复制副本的全局二级索引的列表。

类型:对象数组

GlobalSecondaryIndexes.IndexName

可选

索引的名称。

类型: 字符串

GlobalSecondaryIndexes.ProvisionedThroughputOverride

可选

针对索引的预配置吞吐量的特定于复制副本的配置。

类型: 对象

KmsMasterKeyID

可选

的标识符Amazon KMS客户主密钥 (CMK),用于Amazon KMS加密复制副本。

类型: 字符串

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

可选

当前是否正在进行中。

类型: Boolean

SourceBackupArn

可选

从中还原表的源备份的 ARN。

类型: 字符串

SourceTableArn

可选

备份的源表的 ARN。

类型: 字符串

SseDescription

这些区域有:SseDescription对象提供有关表的服务器端加密的信息。

它可能具有以下属性。

InaccessibleEncryptionDateTime

可选

如果密钥不可访问,则指 DynamoDB 检测到密钥不可访问的日期和时间。

类型: 字符串

格式: 使用date-time中指定的格式RFC 3339 第 5.6 节,互联网日期/时间格式。值不能含有空格。

示例

"InaccessibleEncryptionDateTime": "2020-06-22T17:40:12.322Z"
KmsMasterKeyArn

可选

的 ARNAmazon KMS客户主密钥 (CMK),用于Amazon KMS加密进行存储。

类型: 字符串

SseType

可选

服务器端加密的类型。

类型: 字符串

有效值KMS

Status

可选

服务器端加密的状态。

类型: 字符串

有效值ENABLED | UPDATING

StreamSpecification

这些区域有:StreamSpecification对象包含表的当前 DynamoDB Streams 配置。

它可能具有以下属性。

StreamEnabled

可选

指示是否在表上启用 DynamoDB Streams。

类型: Boolean

StreamViewType

可选

确定写入表的信息。

类型: 字符串

有效值: NEW_IMAGE|OLD_IMAGE|NEW_AND_OLD_IMAGES|KEYS_ONLY

AwsEc2Eip

这些区域有:AwsEc2Eip对象提供有关弹性 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分配为表示与 Amazon VPC 配合使用的 Elastic IP 地址的分配。

类型: 字符串

AssociationId

可选

表示弹性 IP 地址与 EC2 实例的关联的标识符。

类型: 字符串

Domain

可选

要在其中分配地址的域。

如果此地址用于 VPC 中的 EC2 实例,则Domainvpc。否则为Domainstandard

类型: 字符串

有效值standard | vpc

InstanceId

可选

EC2 实例的标识符。

类型: 字符串

NetworkBorderGroup

可选

通告弹性 IP 地址的位置的名称。

类型: 字符串

NetworkInterfaceId

可选

网络接口的标识符。

类型: 字符串

NetworkInterfaceOwnerId

可选

这些区域有:Amazon网络接口拥有者的帐户 ID。

类型: 字符串

格式: 必须是 12 位数字。

PrivateIpAddress

可选

与弹性 IP 地址关联的私有 IP 地址。

类型: IPv4

PublicIp

可选

与 EC2 实例关联的公有 IP 地址。

类型: IPv4

PublicIpv4Pool

可选

IP 地址池的标识符。此参数允许 Amazon EC2 从地址池中选择 IP 地址。

类型: 字符串

AwsEc2Instance

Amazon EC2 实例的详细信息。

类型: 对象

AwsEc2Instance 对象可能具有以下属性。

IamInstanceProfileArn

可选

实例的 IAM 配置文件 ARN。

类型: 字符串

格式: 符合AmazonARN 格式

ImageId

可选

实例的 Amazon 系统映像 (AMI) ID。

类型: 字符串

最大长度: 64

IpV4Addresses

可选

与实例关联的 IPv4 地址。

类型: 最多包含 10 个 IPv4 地址的数组

IpV6Addresses

可选

与实例关联的 IPv6 地址。

类型: 最多包含 10 个 IPv6 地址的数组

KeyName

可选

与实例关联的键名称。

类型: 字符串

最大长度: 128

LaunchedAt

可选

指示启动实例的时间。

类型: 字符串

格式:使用date-time中指定的格式RFC 3339 第 5.6 节,互联网日期/时间格式。值不能含有空格。

NetworkInterfaces

可选

EC2 实例的网络接口的标识符。每个网络接口的详细信息位于相应的AwsEc2NetworkInterface对象。

类型: 对象数组。

SubnetId

可选

启动实例的子网的标识符。

类型: 字符串

最大长度: 32

Type

可选

实例的实例类型。必须为有效的 EC2 实例类型

类型: 字符串

最大长度: 16

VpcId

可选

启动实例的 VPC 的标识符。

类型: 字符串

最大长度: 32

NetworkInterfaces

这些区域有:NetworkInterfaces对象标识 EC2 实例的网络接口。每个网络接口的详细信息位于相应的AwsEc2NetworkInterface对象。

每个网络接口可能具有以下属性。

NetworkInterfaceId

可选

网络接口的标识符。

类型: 字符串

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。

类型: Boolean

NetworkAclId

可选

网络 ACL 的标识符。

类型: 字符串

OwnerId

可选

的标识符Amazon帐户拥有网络 ACL。

类型: 字符串

VpcId

可选

网络 ACL 的 VPC 的标识符。

类型: 字符串

Associations

这些区域有:Associations对象包含网络 ACL 和子网之间的关联。

每个关联可能具有以下属性。

NetworkAclAssociationId

可选

网络 ACL 与子网之间关联的标识符。

类型: 字符串

NetworkAclId

可选

网络 ACL 的标识符。

类型: 字符串

SubnetId

可选

与网络 ACL 关联的子网的标识符。

类型: 字符串

Entries

这些区域有:Entries对象包含网络 ACL 的规则。每个规则根据 IP 地址、流量方向、端口和协议允许或拒绝访问。

每个规则可能具有以下属性。

CidrBlock

可选

要拒绝或允许访问的 IPv4 网络范围。

类型: 字符串

格式: 使用 CIDR 表示法

Egress

可选

规则是否为出口规则。出口规则是适用于离开子网的流量的规则。

类型: Boolean

IcmpTypeCode

可选

要拒绝或允许访问的 Internet 控制消息协议 (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

可选

绑定到网络接口的弹性 IP 地址的地址。

类型: 字符串

SecurityGroups

可选

网络接口的安全组。

类型: 组对象数组

SourceDestCheck

可选

指示是否验证实例的进出流量。

类型: Boolean

Attachment

Attachment 对象提供有关网络接口附加的信息。

它可能具有以下属性。

AttachmentId

可选

网络接口附加的标识符

类型: 字符串

AttachTime

可选

指示何时启动附加。

类型: 字符串

格式: 使用date-time中指定的格式RFC 3339 第 5.6 节,互联网日期/时间格式。值不能含有空格。

DeleteOnTermination

可选

指示在实例终止时是否删除网络接口。

类型: Boolean

DeviceIndex

可选

实例上的网络接口附件的设备索引。

类型: 整数

InstanceId

可选

实例的 ID。

类型: 字符串

InstanceOwnerId

可选

实例所有者的 Amazon 账户 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

可选

安全组所有者的 Amazon 账户 ID。

类型: 字符串

VpcId

可选

[仅限 VPC] 安全组的 VPC 的 ID。

类型: 字符串

IP 权限对象

IpPermissionsIpPermissionsEgress 对象均包含 IP 权限对象数组。

每个 IP 权限对象可能具有以下属性。

FromPort

可选

TCP 和 UDP 协议端口范围的起始端口或者某个 ICMP/ICMPv6 类型编号。

-1 指示所有 ICMP/ICMPv6 类型。如果您指定所有 ICMP/ICMPv6 类型,则必须指定所有代码。

类型: 整数

IpProtocol

可选

IP 协议名称(tcpudpicmpicmpv6)或编号(请参阅协议编号列表)。

[仅限 VPC] 使用 -1 可指定所有协议。

当授权安全组规则时,指定 -1tcpudpicmpicmpv6 意外的协议编号将允许所有端口上的流量,无论您指定的端口范围如何。

对于 tcpudpicmp,您必须指定端口范围。

对于 icmpv6,端口范围是可选的。如果省略端口范围,则允许所有类型和代码的流量。

类型: 字符串

IpRanges

可选

IP 地址范围。

类型: IP 范围对象数组

Ipv6Ranges

可选

IPv6 地址的范围。

类型: IPv6 范围对象的数组

PrefixListIds

可选

[仅 VPC] Amazon 服务的前缀列表 ID。对于出站规则,这是Amazon服务可从与安全组关联的实例中通过 VPC 终端节点访问。

类型: 前缀列表 ID 对象数组

ToPort

可选

TCP 和 UDP 协议的端口范围的结尾协议或 ICMP/ICMPv6 代码。

-1 指示所有 ICMP/ICMPv6 代码。如果您指定所有 ICMP/ICMPv6 类型,则必须指定所有代码。

类型: 整数

UserIdGroupPairs

可选

安全组和 Amazon 账户 ID 对。

类型: 用户 ID 组对对象数组

IpRanges 数组中的每个条目可能具有以下属性。

CidrIp

可选

IP 地址范围。

您可以指定 CIDR 范围或源安全组,但不能同时指定两者。

要指定单个 IPv4 地址,请使用 /32 前缀长度。

要指定单个 IPv6 地址,请使用 /128 前缀长度。

类型: 字符串

Ipv6Ranges 数组中的每个条目可能具有以下属性。

CidrIpv6

可选

IPv6 CIDR 范围。

您可以指定 CIDR 范围或源安全组,但不能同时指定两者。

要指定单个 IPv6 地址,请使用 /128 前缀长度。

PrefixListIds 数组中的每个条目可能具有以下属性。

PrefixListId

可选

前缀 ID。

类型: 字符串

UserIdGroupPairs 数组中的每个条目可能具有以下属性。

GroupId

可选

安全组 ID.

类型: 字符串

GroupName

可选

安全组的名称。

类型: 字符串

PeeringStatus

可选

VPC 对等连接的状态(如果适用)。

类型: 字符串

UserId

可选

Amazon 账户 ID。

对于另一个 VPC 中引用的安全组,将在响应中返回引用的安全组的账户 ID。如果删除了引用的安全组,则不会返回该值。

[Amazon EC2-Classic] 在添加或删除引用另一个安全组的规则时是必需的Amazonaccount.

类型: 字符串

VpcId

引用的安全组的 VPC 标识符(如果适用)。

类型: 字符串

VpcPeeringConnectionId

VPC 对等连接的标识符(如果适用)。

类型: 字符串

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 地址分配给在此子网中创建的网络接口。

类型: Boolean

AvailabilityZone

可选

子网的可用区。

类型: 字符串

AvailabilityZoneId

可选

子网可用区的标识符。

类型: 字符串

AvailableIpAddressCount

可选

子网中可用 IPv4 地址的数量。不包括已停止实例的地址。

类型: 数字

CidrBlock

可选

分配给该子网的 IPv4 CIDR 块。

类型: 字符串

格式: 使用 CIDR 表示法

DefaultForAz

可选

此子网是否为可用区的默认子网。

类型: Boolean

Ipv6CidrBlockAssociationSet

可选

与子网关联的 IPv6 CIDR 块。

类型: 对象数组

MapPublicIpOnLaunch

可选

此子网中的实例是否接收公有 IP 地址。

类型: Boolean

OwnerId

可选

的标识符Amazon帐户拥有子网。

类型: 字符串

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

可选

卷是否加密。

类型: Boolean

KmsKeyId

可选

的 ARNAmazon KMS用于保护卷的卷加密钥的客户主密钥 (CMK)。

类型: 字符串

Size

可选

卷的大小(以 GiB 为单位)。

类型: 整数

SnapshotId

可选

从中创建卷的快照。

类型: 字符串

Status

可选

卷状态。

类型: 字符串

有效值: creating|available|in-use|deleting|deleted|error

Attachments

这些区域有:Attachments对象包含 EC2 卷的附件集。每个附件可能具有以下属性。

AttachTime

可选

启动附件的日期和时间。

类型: 字符串(时间戳)

Format: yyyy-MM-ddTHH:mm:ssZ

DeleteOnTermination

可选

EC2 实例终止时是否删除 EBS 卷。

类型: Boolean

InstanceId

可选

EC2 实例的标识符。

类型: 字符串

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) 选项集的标识符。如果默认选项与 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 块。

类型: IPV4

CidrBlockState

可选

有关 CIDR 块状态的信息。

类型: 字符串

最大长度: 32

IpV6CidrBlockAssociationSet

这些区域有:IPV6CidrBlockAssociationSet对象提供了 IPv6 CIDR 块关联的列表。

每个 CIDR 块关联都可以包含以下属性。

Associationid

可选

IPv6 CIDR 块的关联 ID。

类型: 字符串

最大长度: 32

CidrBlockState

可选

有关 CIDR 块状态的信息。

类型: 字符串

最大长度: 32

IpV6CidrBlock

可选

IPv6 CIDR 块。

类型: 文档 IPV6

AwsEcsCluster

这些区域有:AwsEcsCluster对象提供有关云服务器集群的详细信息。

示例

"AwsEcsCluster": { "CapacityProviders": [], "ClusterSettings": [ { "Name": "containerInsights", "Value": "enabled" } ], "Configuration": { "ExecuteCommandConfiguration": { "KmsKeyId": "kmsKeyId", "LogConfiguration": { "CloudWatchEncryptionEnabled": true, "CloudWatchLogGroupName": "cloudWatchLogGroupName", "S3BucketName": "s3BucketName", "S3EncryptionEnabled": true, "S3KeyPrefix": "s3KeyPrefix" }, "Logging": "DEFAULT" } } "DefaultCapacityProviderStrategy": [ { "Base": 0, "CapacityProvider": "capacityProvider", "Weight": 1 } ] }

AwsEcsCluster 可能具有以下属性。

CapacityProviders

可选

与集群关联的一个或多个容量提供程序的短名称。

类型: 字符串数组

ClusterSettings

可选

用于创建集群的设置。具体来说,ClusterSettings用于配置是否为集群启用 CloudWatch Container Insights。

类型: 对象数组

Configuration

可选

集群的 run 命令配置。

类型: 对象

DefaultCapacityProviderStrategy

可选

为集群设置默认容量提供程序策略。如果在没有指定启动类型或容量提供程序策略的情况下运行服务或任务,则使用默认容量提供程序策略。

类型: 对象数组

ClusterSettings

这些区域有:ClusterSettings对象指示是否为云服务器集群启用 CloudWatch Container Insights。

ClusterSettings是一个包含单个对象的数组。该对象具有以下属性。

Name

可选

设置的名称。

类型: 字符串

有效值containerInsights

Value

可选

设置的值。

类型: 字符串

有效值enabled | disabled

Configuration

这些区域有:Configuration对象包含集群的 run 命令配置。

Configuration包含的ExecuteCommandConfiguration对象。

ExecuteCommandConfiguration 可能具有以下属性。

KmsKeyId

可选

用于加密本地客户端和容器之间的数据的 KMS 密钥的标识符。

类型: 字符串

LogConfiguration

可选

run 命令操作结果的日志配置。必须提供LoggingNONE

类型: 对象

Logging

可选

用于重定向运行命令结果日志的日志设置。

类型: 字符串

有效值DEFAULT | NONE | OVERRIDE

LogConfiguration

这些区域有:LogConfiguration对象包含执行命令操作结果的日志配置。这些日志可以发送到 CloudWatch Logs 或 S3 存储桶。

LogConfiguration 可能具有以下属性。

CloudWatchEncryptionEnabled

可选

是否在 CloudWatch Logs 上启用加密。

类型: Boolean

CloudWatchLogGroupName

可选

要向其发送日志的 CloudWatch Logs 日志组的名称。

类型: 字符串

S3BucketName

可选

要向其发送日志的 S3 存储桶的名称。

类型: 字符串

S3EncryptionEnabled

可选

是否对发送到 S3 存储桶的日志进行加密。

类型: Boolean

S3KeyPrefix

可选

标识 S3 存储桶中要向其发送日志的文件夹。

类型: 字符串

DefaultCapacityProviderStrategy

这些区域有:DefaultCapacityProviderStrategy对象提供集群的默认容量提供程序策略。如果在没有指定启动类型或容量提供程序策略的情况下运行服务或任务,则使用默认容量提供程序策略。

中的每个容量提供程序DefaultCapacityProviderStrategy可能具有以下属性。

Base

可选

要在指定的容量提供程序上运行的最小任务数。

类型: 数字

格式: 整数

CapacityProvider

可选

容量提供程序的名称。

类型: 字符串

Weight

可选

应使用容量提供程序的已启动任务总数的相对百分比。

类型: 数字

AwsEcsTaskDefinition

这些区域有:AwsEcsTaskDefinition对象包含有关任务定义的详细信息。任务定义描述 Amazon Elastic Container Service 任务的容器和卷定义。

示例

"AwsEcsTaskDefinition": { "ContainerDefinitions": [ { "Command": ['ruby', 'hi.rb'], "Cpu":128, "Essential": true, "HealthCheck": { "Command": ["CMD-SHELL", "curl -f http://localhost/ || exit 1"], "Interval": 10, "Retries": 3, "StartPeriod": 5, "Timeout": 20 }, "Image": "tongueroo/sinatra:latest", "Interactive": true, "Links": [], "LogConfiguration": { "LogDriver": "awslogs", "Options": { "awslogs-group": "/ecs/sinatra-hi", "awslogs-region": "ap-southeast-1", "awslogs-stream-prefix": "ecs" }, "SecretOptions": [] }, "MemoryReservation": 128, "Name": "web", "PortMappings": [ { "ContainerPort": 4567, "HostPort":4567, "Protocol": "tcp" } ], "Privileged": true, "StartTimeout": 10, "StopTimeout": 100, } ], "Family": "sinatra-hi", "NetworkMode": "host", "RequiresCompatibilities": ["EC2"], "TaskRoleArn": "arn:aws:iam::111122223333:role/ecsTaskExecutionRole", }

AwsEcsTaskDefinition 可能具有以下属性。

ContainerDefinitions

可选

描述组成该任务的容器的定义的列表。

类型: 对象数组

Cpu

可选

任务所使用的 CPU 单元的数量。

类型: 字符串

有效值: 对于 EC2 启动类型,对值没有限制。

对于 Fargate 启动类型,值必须是以下内容之一:256 (.25 vCPU)|512 (.5 vCPU)|1024 (1 vCPU)|2048 (2 vCPU)|4096 (4 vCPU)

ExecutionRoleArn

可选

任务执行角色的 ARN,该角色授予 Amazon ECS 容器代理进行Amazon代表容器用户进行 API 调用。

类型: 字符串

Family

可选

此任务定义注册到的系列的名称。

类型: 字符串

最大长度: 255

允许使用的字符: A-Z、a-z、0-9、-、_

InferenceAccelerators

可选

用于任务中的容器的 Elastic Inference 加速器。

类型: 对象数组

IpcMode

可选

用于任务中的容器的 IPC 资源命名空间。

类型: 字符串

有效值host | task | none

Memory

可选

任务使用的内存量 (以 MB 为单位)。

类型: 字符串

对于 EC2 启动类型,可提供任务级内存值或容器级内存值。

对于 Fargate 启动类型,内存的可用值基于Cpu属性。

Cpu

可用值Memory

256 (.25 vCPU)

512 (0.5GB) | 1024 (1GB) | 2048 (2GB)

512 (.5 vCPU)

1 英寸(1 英寸)| 2048(2 英寸)| 3072(3 GB)| 4096(4 GB)

1024 (1 vCPU)

2 英镑(3 英镑)| 4096(4 英镑)| 5120(5 英镑)| 6144(6 英镑)| 7168(7 英镑)| 8192(8 英镑)

2048 (2 vCPU)

4096 (4GB) 到 16384 (16GB) 之间(以 1024 (1GB) 为增量)

4096 (4 vCPU)

8192 (8GB) 到 30720 (30GB) 之间(以 1024 (1GB) 为增量)

NetworkMode

可选

在任务中用于容器的 Docker 联网模式。

类型: 字符串

有效值: awsvpc|bridge|host|none

PidMode

可选

用于任务中的容器的过程命名空间。

类型: 字符串

有效值host | task

PlacementConstraints

可选

要用于任务的放置约束对象。

类型: 对象数组

ProxyConfiguration

可选

App Mesh 代理的配置详细信息。

类型: 对象

RequiresCompatibilities

可选

验证任务定义时参照的任务启动类型。

类型: 字符串数组

TaskRoleArn

可选

为任务中的容器授予权限以调用的 IAM 角色的简称或 ARNAmazon代表您执行 API 操作。

类型: 字符串

Volumes

可选

任务的数据卷定义。

类型: 对象数组

ContainerDefinitions

这些区域有:ContainerDefinitions对象包含容器定义的列表,这些定义描述了组成该任务的容器。

每个容器定义可能具有以下属性。

Command

可选

传递给容器的命令。

类型: 字符串数组

Cpu

可选

为容器预留的 CPU 单位数。

类型: 数字

DependsOn

可选

针对容器启动和关闭定义的依赖关系。

类型: 对象数组

DisableNetworking

可选

是否在容器中禁用网络。

类型: Boolean

DnsSearchDomains

可选

提供给容器的 DNS 搜索域的列表。

类型: 字符串数组

DnsServers

可选

提供给容器的 DNS 服务器的列表。

类型: 字符串数组

DockerLabels

可选

要添加到容器的标签的键值映射。

类型: 字符串的映射

DockerSecurityOptions

可选

用于为 SELinux 和 AppArmor 多级别安全系统提供自定义标签的字符串列表。

类型: 字符串数组

EntryPoint

可选

传递给容器的入口点。

类型: 字符串数组

Environment

可选

要传递给容器的环境变量。

类型: 对象数组

EnvironmentFiles

可选

包含要传递到容器的环境变量的文件列表。

类型: 对象数组

Essential

可选

容器是否是必不可少的。

如果true(默认值),则如果容器出现故障或停止,任务中的其他容器也会停止。

如果false,则容器故障不会影响任务中的其他容器。

所有任务都必须具有至少一个主要容器。

类型: Boolean

ExtraHosts

可选

要追加到容器上的 /etc/hosts 文件的主机名和 IP 地址映射的列表。

类型: 对象数组

FirelensConfiguration

可选

容器的 FireLens 配置。为容器日志指定和配置日志路由器。

类型: 对象

HealthCheck

可选

容器的运行状况检查命令和关联的配置参数。

类型: 对象

Hostname

可选

要用于容器的主机名。

类型: 字符串

Image

可选

用于启动容器的映像。

类型: 字符串

Interactive

可选

如果设置为 true,则可以部署容器化应用程序,这些应用程序需要stdintty待分配。

类型: Boolean

Links

可选

表单中容器的链接列表container_name:alias。允许容器相互进行通信,而无需端口映射。

类型: 字符串数组

LinuxParameters

可选

应用到容器的特定于 Linux 的修改,例如 Linux 内核功能。

类型: 对象

LogConfiguration

可选

容器的日志配置规范。

类型: 对象

Memory

可选

要提供给容器的内存量(以 MiB 为单位)。如果容器试图超出此处指定的内存,则容器将被关闭。为任务中的所有容器预留的内存总量必须低于任务内存值(如果指定了任务内存值)。

类型: 数字

MemoryReservation

可选

要为容器预留的内存量的软限制(以 MiB 为单位)。

类型: 数字

MountPoints

可选

容器中的数据卷的挂载点。

类型: 对象数组

Name

可选

容器的名称。

类型: 字符串

PortMappings

可选

容器的端口映射的列表。

类型: 对象数组

Privileged

可选

是否向容器提供对主机容器实例的提升的特权。提升的权限与 root 用户类似。

类型: Boolean

PseudoTerminal

可选

是否将 TTY 分配给容器。

类型: Boolean

ReadonlyRootFilesystem

可选

是否为容器提供对其根文件系统的只读访问权。

类型: Boolean

RepositoryCredentials

可选

要使用的私有存储库身份验证凭证。

类型: 对象

ResourceRequirements

可选

要分配给容器的资源的类型和数量。目前唯一支持的资源为 GPU。

类型: 对象数组

Secrets

可选

要传递到容器的密钥。

类型: 对象数组

StartTimeout

可选

在放弃解析容器的依赖项之前要等待的秒数。

类型: 数字

StopTimeout

可选

容器由于未自行正常关闭而停止前要等待的秒数。

类型: 数字

SystemControls

可选

要在容器中设置的具有命名空间的内核参数的列表。

类型: 对象数组

Ulimits

可选

要在容器中设置的 ulimits 的列表。

类型: 对象数组

User

可选

要在容器内使用的用户。

类型: 字符串

值可能使用以下格式之一。

  • user

  • user:group

  • uid

  • uid:gid

  • user:gid

  • uid:group

VolumesFrom

可选

要从其他容器挂载的数据卷。

类型: 对象数组

WorkingDirectory

可选

容器中用于运行命令的工作目录。

类型: 字符串

ContainerDefinitions.DependsOn

这些区域有:DependsOn对象包含为容器启动和关闭定义的依赖关系列表。

每个依赖关系可能具有以下属性。

Condition

可选

依赖容器的依赖项条件。指示当前容器可以启动之前从属容器的必需状态。

类型: 字符串

有效值: START|COMPLETE|SUCCESS|HEALTHY

ContainerName

可选

从属容器的名称。

类型: 字符串

ContainerDefinitions.Environment

这些区域有:Environment对象列出要传递到容器的环境变量。

每个变量可能具有以下属性。

Name

可选

环境变量的名称。

类型: 字符串

Value

可选

环境变量的值。

类型: 字符串

ContainerDefinitions.EnvironmentFiles

这些区域有:EnvironmentFiles对象包含包含要传递给容器的环境变量的文件列表。

每个文件可能具有以下属性。

Type

可选

环境文件的类型。

类型: 字符串

有效值s3

Value

可选

包含环境变量文件的 S3 对象的 ARN。

类型: 字符串

ContainerDefinitions.ExtraHosts

这些区域有:ExtraHosts对象包含要追加到/etc/hosts文件。

每个条目可能具有以下属性。

Hostname

可选

要用于 /etc/hosts 条目中的主机名。

类型: 字符串

IpAddress

可选

要用于 /etc/hosts 条目中的 IP 地址。

类型: 字符串

ContainerDefinitions.FirelensConfiguration

这些区域有:FirelensConfiguration对象描述了容器的 FireLens 配置。配置为容器日志指定和配置日志路由器。

FireLensConfiguration 可能具有以下属性。

Options

可选

用于配置日志路由器的选项。

类型: 字符串的映射

有效的选项键如下所示:

  • enable-ecs-log-metadata。 该值可以是true或者false

  • config-file-type。 该值可以是s3或者file

  • config-file-value。 值可以是 S3 ARN 或文件路径。

Type

可选

要使用的日志路由器。

类型:string

有效值fluentd | fluentbit

ContainerDefinitions.HealthCheck

这些区域有:HealthCheck对象包含容器的运行状况检查命令和关联的配置参数。

HealthCheck 可能具有以下属性。

Command

可选

容器运行的命令,用于确定其运行状况是否正常。

类型: 字符串数组

Interval

可选

执行每次运行状况检查间隔的时间,以秒为单位。默认值为 30 秒。

类型: 数字

最小值: 5

最大值: 300

Retries

可选

重试失败的运行状况检查的次数,超过该次数将容器视为不正常。默认值为 3。

类型: 数字

最小值: 1

最大值: 10

StartPeriod

可选

允许容器在运行状况检查失败之前引导的可选宽限期(以秒为单位)计数为最大重试次数。

类型: 数字

最小值: 0

最大值: 300

Timeout

可选

等待运行状况检查成功执行的时间长度,以秒为单位,超过该时间则视为失败。默认值是 5。

类型:number

最小值: 2

最大值: 60

ContainerDefinitions.LinuxParameters

这些区域有:LinuxParameters对象包含应用到容器的特定于 Linux 的修改,例如 Linux 内核功能。

LinuxParameters 可能具有以下属性。

Capabilities

可选

容器的 Linux 功能,这些功能已在 Docker 提供的默认配置中添加或删除。

类型: 对象

Devices

可选

要向容器公开的主机设备。

类型: 对象数组

InitProcessEnabled

可选

是否运行init进程转发信号和获得进程。

类型: Boolean

MaxSwap

可选

容器可以使用的交换内存总量(以 MiB 为单位)。

类型: 数字

SharedMemorySize

可选

/dev/shm 卷的大小值 (以 MiB 为单位)。

类型: 数字

Swappiness

可选

配置容器的内存交换行为。确定如何积极地交换页面。值越大,互换性越高。默认值为 60。

类型: 数字

最小值: 0

最大值: 100

Tmpfs

可选

tmpfs 挂载的容器路径、挂载选项和大小 (以 MiB 为单位)。

类型: 对象数组

Capabilities

这些区域有:Capabilities对象列出容器的 Linux 功能,这些功能已在 Docker 提供的默认配置中添加或删除。

Capabilities 可能具有以下属性。

Add

可选

容器的 Linux 功能,这些功能已添加到 Docker 提供的默认配置。

类型: 字符串数组

有效值: "ALL"|"AUDIT_CONTROL"| "AUDIT_WRITE"|"BLOCK_SUSPEND"|"CHOWN"|"DAC_OVERRIDE"|"DAC_READ_SEARCH"|"FOWNER"|"FSETID"|"IPC_LOCK"|"IPC_OWNER"|"KILL"|"LEASE"|"LINUX_IMMUTABLE"|"MAC_ADMIN"| "MAC_OVERRIDE"|"MKNOD"|"NET_ADMIN"|"NET_BIND_SERVICE"|"NET_BROADCAST"|"NET_RAW"|"SETFCAP"|"SETGID"|"SETPCAP"|"SETUID"|"SYS_ADMIN"|"SYS_BOOT"|"SYS_CHROOT"|"SYS_MODULE"|"SYS_NICE"|"SYS_PACCT"|"SYS_PTRACE"|"SYS_RAWIO"|"SYS_RESOURCE"|"SYS_TIME"|"SYS_TTY_CONFIG"|"SYSLOG"|"WAKE_ALARM"

Drop

可选

容器的 Linux 功能,这些功能已从 Docker 提供的默认配置中删除。

类型: 字符串数组

有效值: "ALL"|"AUDIT_CONTROL"| "AUDIT_WRITE"|"BLOCK_SUSPEND"|"CHOWN"|"DAC_OVERRIDE"|"DAC_READ_SEARCH"|"FOWNER"|"FSETID"|"IPC_LOCK"|"IPC_OWNER"|"KILL"|"LEASE"|"LINUX_IMMUTABLE"|"MAC_ADMIN"| "MAC_OVERRIDE"|"MKNOD"|"NET_ADMIN"|"NET_BIND_SERVICE"|"NET_BROADCAST"|"NET_RAW"|"SETFCAP"|"SETGID"|"SETPCAP"|"SETUID"|"SYS_ADMIN"|"SYS_BOOT"|"SYS_CHROOT"|"SYS_MODULE"|"SYS_NICE"|"SYS_PACCT"|"SYS_PTRACE"|"SYS_RAWIO"|"SYS_RESOURCE"|"SYS_TIME"|"SYS_TTY_CONFIG"|"SYSLOG"|"WAKE_ALARM"

Devices

这些区域有:Devices对象包含要向容器公开的主机设备。

每个设备可能具有以下属性。

ContainerPath

可选

向主机设备公开的容器内的路径。

类型:string

HostPath

可选

主机容器实例上的设备路径。

类型:string

Permissions

可选

提供给设备的容器的显式权限。默认情况下,容器具有读取、写入和mknod对于设备。

类型: 字符串数组

Tmpfs

这些区域有:Tmpfs对象包含 tmpfs 挂载的容器路径、挂载选项和大小(以 MiB 为单位)。

每个条目可能具有以下属性。

ContainerPath

可选

要挂载 tmpfs 卷的绝对文件路径。

类型:string

MountOptions

可选

tmpfs 卷挂载选项列表。

类型: 字符串数组

有效值: "defaults"|"ro"|"rw"|"suid"|"nosuid"|"dev"|"nodev"| "exec"|"noexec"|"sync"|"async"|"dirsync"|"remount"|"mand"|"nomand"|"atime"|"noatime"|"diratime"|"nodiratime"|"bind"|"rbind"|"unbindable"|"runbindable"|"private"|"rprivate"|"shared"|"rshared"|"slave"|"rslave"|"relatime"|"norelatime"|"strictatime"|"nostrictatime"| "mode"|"uid"|"gid"|"nr_inodes"| "nr_blocks"|"mpol"

Size

可选

tmpfs 卷的最大大小(以 MiB 为单位)。

类型:number

ContainerDefinitions.LogConfiguration

这些区域有:LogConfiguration对象包含容器的日志配置规范。

LogConfiguration 可能具有以下属性。

LogDriver

可选

要用于容器的日志驱动程序。

类型: 字符串

上的有效值Amazon Fargate: awslogs|splunk|awsfirelens

EC2 实例上的有效值: awslogs|fluentd|gelf|json-file|journald|logentries|syslog|splunk|awsfirelens

Options

可选

要发送到日志驱动程序的配置选项。要求您容器实例上的 Docker Remote API 版本为 1.19 或更高版本。

类型: 字符串的映射

SecretOptions

可选

要传递到日志配置的密钥。

类型: 对象数组

SecretOptions

这些区域有:SecretOptions对象包含要传递到日志配置的密钥。

每个密钥可能具有以下属性。

Name

可选

密钥的名称。

类型:string

ValueFrom

可选

要向容器公开的密钥。

该值为密钥管理器密钥的完整 ARN 或 Systems Manager Parameter Store 中的参数的完整 ARN。

类型: 字符串

ContainerDefinitions.MountPoints

这些区域有:MountPoints对象列出容器中的数据卷的挂载点。

每个挂载点可能具有以下属性。

ContainerPath

可选

要将主机卷挂载到的容器上的路径。

类型: 字符串

ReadOnly

可选

容器是否具有卷的只读访问权限。

类型: Boolean

SourceVolume

可选

要挂载的卷的名称。必须与Volumes对象。

类型: 字符串

ContainerDefinitions.PortMappings

这些区域有:PortMappings对象包含容器的端口映射的列表。

每个端口映射可能具有以下属性。

ContainerPort

可选

绑定到用户指定的或自动分配的主机端口的容器上的端口号。

类型: 数字

HostPort

可选

要为容器预留的容器实例上的端口号。

类型: 数字

Protocol

可选

用于端口映射的协议。默认为 tcp

类型: 字符串

有效值tcp | udp

ContainerDefinitions.RepositoryCredentials

这些区域有:RepositoryCredentials对象包含要使用的私有存储库身份验证凭证。

RepositoryCredentials 可能具有以下属性。

CredentialsParameter

可选

包含私有存储库凭证的密钥的 ARN。

类型:string

ContainerDefinitions.ResourceRequirements

这些区域有:ResourceRequirements对象包含要分配给容器的资源列表。

每个资源可能具有以下属性。

Type

可选

要分配给资源的容器的类型。

类型: 字符串

有效值GPU | InferenceAccelerator

Value

可选

指定的资源类型的值。

适用于GPU,则表示 Amazon ECS 容器代理为容器预留的物理 GPU 的数量。

适用于InferenceAccelerator,则值应与DeviceName属性InferenceAccelerators对象。

类型: 字符串

ContainerDefinitions.Secrets

这些区域有:Secrets对象包含要传递给容器的密钥。

每个密钥可能具有以下属性。

Name

可选

密钥的名称。

类型: 字符串

ValueFrom

可选

要向容器公开的密钥。该值为密钥管理器密钥的完整 ARN 或 Systems Manager Parameter Store 中的参数的完整 ARN。

类型: 字符串

ContainerDefinitions.SystemControls

这些区域有:SystemControls对象包含要在容器中设置的具有命名空间的内核参数的列表。

每个参数可能具有以下属性。

Namespace

可选

要为其设置值的命名空间内核参数。

类型: 字符串

Value

可选

参数的值。

类型: 字符串

ContainerDefinitions.Ulimits

这些区域有:Ulimits对象包含要在容器中设置的 ulimits 的列表。

每个 ulimit 可能具有以下属性。

HardLimit

可选

ulimit 类型的硬限制。

类型: 数字

Name

可选

ulimit 的类型。

类型: 字符串

有效值: core|cpu|data|fsize|locks|memlock|msgqueue|nice|nofile|nproc|rss|rtprio|rttime|sigpending|stack

SoftLimit

可选

ulimit 类型的软限制。

类型: 数字

ContainerDefinitions.VolumesFrom

这些区域有:VolumesFrom对象包含要从其他容器挂载的数据卷的列表。

每个数据卷可能具有以下属性。

ReadOnly

可选

容器是否具有卷的只读访问权限。

类型: Boolean

SourceContainer

可选

相同任务定义中要从中挂载卷的另一个容器的名称。

类型: 字符串

InferenceAccelerators

这些区域有:InferenceAccelerators对象包含用于任务中的容器的 Elastic Inference 加速器列表。

每个加速器可能具有以下属性。

DeviceName

可选

Elastic Inference 加速器设备名称。

类型: 字符串

DeviceType

可选

要使用的 Elastic Inference 加速器类型。

类型: 字符串

PlacementConstraints

这些区域有:PlacementConstraints对象包含要用于任务的放置约束对象的列表。

每个放置约束可能具有以下属性。

Expression

可选

应用于约束的集群查询语言表达式。

类型: 字符串

Type

可选

约束类型。

类型: 字符串

ProxyConfiguration

这些区域有:ProxyConfiguration对象包含 App Mesh 代理的配置详细信息。

ProxyConfiguration 可能具有以下属性。

ContainerName

可选

将作为 App Mesh 代理的容器的名称。

类型: 字符串

ProxyConfigurationProperties

可选

提供给容器网络接口 (CNI) 插件的网络配置参数集,以键值对形式指定。

类型: 对象数组

Type

可选

代理类型。

类型: 字符串

有效值APPMESH

ProxyConfigurationProperties

这些区域有:ProxyConfigurationProperties对象包含提供给容器网络接口 (CNI) 插件的网络配置参数集。

每个条目可能具有以下属性。

Name

可选

属性的名称。

类型: 字符串

Value

可选

属性的值。

类型: 字符串

Volumes

这些区域有:Volumes对象列出要从其他容器挂载的数据卷。

每个数据卷可能具有以下属性。

DockerVolumeConfiguration

可选

Docker 卷的信息。

类型: 对象

EfsVolumeConfiguration

有关用于任务存储的 Amazon Elastic File System 文件系统的信息。

可选

类型: 对象

Host

可选

绑定挂载主机卷的信息。

类型: 对象

Name

数据卷的名称。

可选

类型: 字符串

DockerVolumeConfiguration

这些区域有:DockerVolumeConfiguration对象提供有关 Docker 卷的信息。

DockerVolumeConfiguration 可能具有以下属性。

Autoprovision

可选

如果 Docker 卷尚不存在,则是否自动创建它。

类型: Boolean

Driver

可选

要使用的 Docker 卷驱动程序。

类型: 字符串

DriverOpts

可选

传递的 Docker 驱动程序特定选项的映射。

类型: 字符串的映射

Labels

可选

要添加到 Docker 卷的自定义元数据。

类型: 字符串的映射

Scope

可选

确定其生命周期的 Docker 卷的范围。当任务启动时,将自动预置范围限定为任务的 Docker 卷;而当任务停止时销毁此卷。任务停止后,共享的 Docker 卷将持续存在。

类型: 字符串

有效值shared | task

EfsVolumeConfiguration

这些区域有:EfsVolumeConfiguration对象提供有关用于任务存储的 Amazon Elastic File System (Amazon EFS) 文件系统的信息。

EfsVolumeConfiguration 可能具有以下属性。

AuthorizationConfig

可选

Amazon EFS 文件系统的授权配置详细信息。

类型: 对象

AuthorizationConfig.AccessPointId

可选

要使用的 Amazon EFS 访问点标识符。

类型: 字符串

AuthorizationConfig.Iam

可选

挂载 Amazon EFS 文件系统时是否使用在任务定义中定义的 Amazon ECS 任务 IAM 角色。

类型: 字符串

有效值DISABLED | ENABLED

FilesystemId

可选

要使用的 Amazon EFS 文件系统标识符。

类型: 字符串

RootDirectory

可选

Amazon EFS 文件系统中要作为主机内的根目录挂载的目录。

类型: 字符串

TransitEncryption

可选

是否对 Amazon ECS 主机和 Amazon EFS 服务器之间传输的 Amazon EFS 数据启用加密。

类型: 字符串

有效值DISABLED | ENABLED

TransitEncryptionPort

可选

在 Amazon ECS 主机和 Amazon EFS 服务器之间发送加密数据时要使用的端口。

类型: 数字

Host

这些区域有:Host对象提供有关绑定挂载主机卷的信息。

Host 可能具有以下属性。

SourcePath

可选

向容器提供的主机容器实例上的路径。Fargate 启动类型不支持。

类型: 字符串

AwsElasticBeanstalkEnvironment

这些区域有:AwsElasticBeanstalkEnvironment对象包含有关Amazon 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

可选

此环境别名记录的 URL。

类型: 字符串

最小长度: 1

最大长度: 255

DateCreated

可选

此环境的创建日期。

类型: 字符串

格式: 使用date-time中指定的格式RFC 3339 第 5.6 节,互联网日期/时间格式。值不能含有空格。

DateUpdated

可选

上次修改环境的日期。

类型: 字符串

格式: 使用date-time中指定的格式RFC 3339 第 5.6 节,互联网日期/时间格式。值不能含有空格。

Description

可选

关于环境的描述。

类型: 字符串

EndpointUrl

可选

对于负载均衡的 Auto Scaling 环境,则为指向负载均衡器的 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 中设置配置选项的详细信息,请参阅配置选项中的Amazon 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

可选

有关域状态的详细信息。

类型: 对象

<