ResourcePolicyStatement - AWS Serverless Application Model
语法属性示例
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅中国的 AWS 服务入门。

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

ResourcePolicyStatement

为API的所有方法和路径配置资源策略。有关资源策略的更多信息,请参阅 通过控制对API的访问 API 网关 资源策略 在 API 网关 开发人员指南.

语法

若要在您的 AWS 无服务器应用程序模型 (AWS SAM)模板,请使用以下语法。

属性

AwsAccountBlacklist

的 AWS 帐户以阻止。

类型:列表

必需: 否

AWS CloudFormation 兼容性: 此属性是 AWS SAM 并且没有 AWS CloudFormation 等效。

AwsAccountWhitelist

的 AWS 帐户以允许。有关此属性的使用示例,请参阅本页底部的示例部分。

类型:列表

必需: 否

AWS CloudFormation 兼容性: 此属性是 AWS SAM 并且没有 AWS CloudFormation 等效。

CustomStatements

要应用于此API的自定义资源策略语句列表。有关此属性的使用示例,请参阅本页底部的示例部分。

类型:列表

必需: 否

AWS CloudFormation 兼容性: 此属性是 AWS SAM 并且没有 AWS CloudFormation 等效。

IntrinsicVpcBlacklist

要阻止的虚拟私有云(VPC)列表,其中每个VPC都被指定为参考,例如 动态参考 或 Ref 内在功能. 有关此属性的使用示例,请参阅本页底部的示例部分。

类型:列表

必需: 否

AWS CloudFormation 兼容性: 此属性是 AWS SAM 并且没有 AWS CloudFormation 等效。

IntrinsicVpcWhitelist

列表 VPCs 允许,其中每个VPC都指定为参考,例如 动态参考 或 Ref 内在功能.

类型:列表

必需: 否

AWS CloudFormation 兼容性: 此属性是 AWS SAM 并且没有 AWS CloudFormation 等效。

IntrinsicVpceBlacklist

要阻止的VPC端点列表,其中每个VPC端点都指定为参考,例如 动态参考 或 Ref 内在功能.

类型:列表

必需: 否

AWS CloudFormation 兼容性: 此属性是 AWS SAM 并且没有 AWS CloudFormation 等效。

IntrinsicVpceWhitelist

要允许的VPC端点列表,其中每个VPC端点都被指定为参考,例如 动态参考 或 Ref 内在功能. 有关此属性的使用示例,请参阅本页底部的示例部分。

类型:列表

必需: 否

AWS CloudFormation 兼容性: 此属性是 AWS SAM 并且没有 AWS CloudFormation 等效。

IpRangeBlacklist

IP地址或地址范围以阻止。有关此属性的使用示例,请参阅本页底部的示例部分。

类型:列表

必需: 否

AWS CloudFormation 兼容性: 此属性是 AWS SAM 并且没有 AWS CloudFormation 等效。

IpRangeWhitelist

要允许的IP地址或地址范围。

类型:列表

必需: 否

AWS CloudFormation 兼容性: 此属性是 AWS SAM 并且没有 AWS CloudFormation 等效。

SourceVpcBlacklist

源VPC或VPC端点以阻止。源VPC名称必须以 "vpc-" 源VPC端点名称必须以 "vpce-"。有关此属性的使用示例,请参阅本页底部的示例部分。

类型:列表

必需: 否

AWS CloudFormation 兼容性: 此属性是 AWS SAM 并且没有 AWS CloudFormation 等效。

SourceVpcWhitelist

允许源VPC或VPC端点。源VPC名称必须以 "vpc-" 源VPC端点名称必须以 "vpce-".

类型:列表

必需: 否

AWS CloudFormation 兼容性: 此属性是 AWS SAM 并且没有 AWS CloudFormation 等效。

示例

资源策略示例

以下示例阻止两个IP地址和源VPC,并允许 AWS 帐户。

YAML

Auth:
  ResourcePolicy:
    CustomStatements: [{
                         "Effect": "Allow",
                         "Principal": "*",
                         "Action": "execute-api:Invoke",
                         "Resource": "execute-api:/Prod/GET/pets",
                         "Condition": {
                           "IpAddress": {
                             "aws:SourceIp": "1.2.3.4"
                           }
                         }
                       }]
    IpRangeBlacklist:
      - "10.20.30.40"
      - "1.2.3.4"
    SourceVpcBlacklist:
      - "vpce-1a2b3c4d"
    AwsAccountWhitelist:
      - "111122223333"
    IntrinsicVpcBlacklist:
      - "{{resolve:ssm:SomeVPCReference:1}}" 
      - !Ref MyVPC
    IntrinsicVpceWhitelist:
      - "{{resolve:ssm:SomeVPCEReference:1}}" 
      - !Ref MyVPCE