ResourcePolicyStatement

Mengonfigurasi kebijakan sumber daya untuk semua metode dan jalur API. Untuk informasi selengkapnya tentang kebijakan sumber daya, lihat Mengendalikan akses ke API dengan kebijakan sumber daya API Gateway di Panduan Developer API Gateway.

Sintaks

Untuk mendeklarasikan entitas ini dalam template AWS Serverless Application Model (AWS SAM) Anda, gunakan sintaks berikut.

YAML

  AwsAccountBlacklist: List
  AwsAccountWhitelist: List
  CustomStatements: List
  IntrinsicVpcBlacklist: List
  IntrinsicVpcWhitelist: List
  IntrinsicVpceBlacklist: List
  IntrinsicVpceWhitelist: List
  IpRangeBlacklist: List
  IpRangeWhitelist: List
  SourceVpcBlacklist: List
  SourceVpcWhitelist: List

Properti

AwsAccountBlacklist

AWS Akun yang akan diblokir.

Jenis: Daftar String

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

AwsAccountWhitelist

AWS Akun untuk memungkinkan. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.

Jenis: Daftar String

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

CustomStatements

Daftar pernyataan kebijakan sumber daya kustom untuk diterapkan ke API ini. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.

Tipe: Daftar

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

IntrinsicVpcBlacklist

Daftar virtual private cloud (VPC) yang akan diblokir, dengan setiap VPC ditetapkan sebagai referensi seperti referensi dinamis atau fungsi intrinsik Ref. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.

Tipe: Daftar

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

IntrinsicVpcWhitelist

Daftar VPC yang akan diizinkan, dengan setiap VPC ditetapkan sebagai referensi seperti referensi dinamis atau fungsi intrinsik Ref.

Tipe: Daftar

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

IntrinsicVpceBlacklist

Daftar VPC endpoint yang akan diblokir, dengan setiap VPC endpoint ditetapkan sebagai referensi seperti referensi dinamis atau fungsi intrinsik Ref.

Tipe: Daftar

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

IntrinsicVpceWhitelist

Daftar VPC endpoint yang akan diizinkan, dengan setiap VPC endpoint ditetapkan sebagai referensi seperti referensi dinamis atau fungsi intrinsik Ref. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.

Tipe: Daftar

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

IpRangeBlacklist

Alamat IP atau jangkauan alamat yang akan diblokir. Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.

Tipe: Daftar

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

IpRangeWhitelist

Alamat IP atau jangkauan alamat yang akan diizinkan.

Tipe: Daftar

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

SourceVpcBlacklist

Sumber VPC atau VPC endpoint yang akan diblokir. Nama VPC sumber harus dimulai dengan "vpc-" dan nama VPC endpoint sumber harus dimulai dengan "vpce-". Untuk contoh penggunaan properti ini, lihat bagian Contoh di bagian bawah halaman ini.

Tipe: Daftar

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

SourceVpcWhitelist

VPC sumber atau VPC endpoint yang akan diizinkan. Nama VPC sumber harus dimulai dengan "vpc-" dan nama VPC endpoint sumber harus dimulai dengan "vpce-".

Tipe: Daftar

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini unik AWS SAM dan tidak memiliki AWS CloudFormation padanan.

Contoh

Contoh Kebijakan Sumber Daya

Contoh berikut memblokir dua alamat IP dan VPC sumber, dan memungkinkan akun 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