ResourcePolicyStatement - AWS Serverless Application Model
構文プロパティ例

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

ResourcePolicyStatement

API 上のすべてのメソッドとパスのリソースポリシーを設定します。リソースポリシーの詳細については、API Gateway デベロッパーガイドの「API Gateway リソースポリシーを使用して API へのアクセスを制御する」を参照してください。

構文

AWS Serverless Application Model (AWS SAM) テンプレートでこのエンティティを宣言するには、以下の構文を使用します。

プロパティ

AwsAccountBlacklist

ブロックする AWS アカウントです。

タイプ: 文字列のリスト

必須: いいえ

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。

AwsAccountWhitelist

許可する AWS アカウントです。このプロパティの使用例については、このページの下部にある「例」セクションを参照してください。

型: 文字列のリスト

必須: いいえ

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。

CustomStatements

この API に適用するカスタムリソースポリシーステートメントのリストです。このプロパティの使用例については、このページの下部にある「例」セクションを参照してください。

タイプ: リスト

必須: いいえ

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。

IntrinsicVpcBlacklist

ブロックする仮想プライベートクラウド (VPC) のリストで、各 VPC が動的参照または Ref 組み込み関数などのリファレンスとして指定されます。このプロパティの使用例については、このページの下部にある「例」セクションを参照してください。

タイプ: リスト

必須: いいえ

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。

IntrinsicVpcWhitelist

許可する VPC のリストで、各 VPC が動的参照または Ref 組み込み関数などのリファレンスとして指定されます。

タイプ: リスト

必須: いいえ

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。

IntrinsicVpceBlacklist

ブロックする VPC エンドポイントのリストで、各 VPC エンドポイントが動的参照または Ref 組み込み関数などのリファレンスとして指定されます。

タイプ: リスト

必須: いいえ

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。

IntrinsicVpceWhitelist

許可する VPC エンドポイントのリストで、各 VPC エンドポイントが動的参照または Ref 組み込み関数などのリファレンスとして指定されます。このプロパティの使用例については、このページの下部にある「例」セクションを参照してください。

タイプ: リスト

必須: いいえ

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。

IpRangeBlacklist

ブロックする IP アドレスまたはアドレス範囲です。このプロパティの使用例については、このページの下部にある「例」セクションを参照してください。

タイプ: リスト

必須: いいえ

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。

IpRangeWhitelist

許可する IP アドレスまたはアドレス範囲です。

タイプ: リスト

必須: いいえ

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。

SourceVpcBlacklist

ブロックするソース VPC またはソース VPC エンドポイントです。ソース VPC 名は "vpc-" で始まり、ソース VPC エンドポイント名は "vpce-" で始まる必要があります。このプロパティの使用例については、このページの下部にある「例」セクションを参照してください。

タイプ: リスト

必須: いいえ

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。

SourceVpcWhitelist

許可するソース VPC またはソース VPC エンドポイントです。ソース VPC 名は "vpc-" で始まり、ソース VPC エンドポイント名は "vpce-" で始まる必要があります。

タイプ: リスト

必須: いいえ

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。

例

リソースポリシーの例

以下の例は、2 つの IP アドレスと 1 つのソース 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