ResourcePolicyStatement

Configure une stratégie de ressource pour toutes les méthodes et chemins d'accès d'une API. Pour plus d'informations sur les stratégies de ressources, consultez Contrôle de l'accès à une API avec des stratégies de ressources API Gateway dans le Guide du développeur API.

Syntaxe

Pour déclarer cette entité dans votre modèle AWS Serverless Application Model (AWS SAM), utilisez la syntaxe suivante.

YAML

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

Propriétés

AwsAccountBlacklist

Les AWS comptes à bloquer.

Type : liste de chaînes

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

AwsAccountWhitelist

Les AWS comptes à autoriser. Pour obtenir un exemple d'utilisation de cette propriété, consultez la section Exemples en bas de cette page.

Type : liste de chaînes

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

CustomStatements

Une liste des instructions de stratégie de ressource personnalisées à appliquer à cette API. Pour obtenir un exemple d'utilisation de cette propriété, consultez la section Exemples en bas de cette page.

Type : liste

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

IntrinsicVpcBlacklist

La liste des clouds privés virtuels (VPC) à bloquer, où chaque VPC est spécifié comme une référence telle qu'une Référence dynamique ou la fonction intrinsèque Ref. Pour obtenir un exemple d'utilisation de cette propriété, consultez la section Exemples en bas de cette page.

Type : liste

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

IntrinsicVpcWhitelist

La liste des VPC à autoriser, où chaque VPC est spécifié comme une référence telle qu'une référence dynamique ou la fonction intrinsèque de Ref.

Type : liste

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

IntrinsicVpceBlacklist

Liste des points de terminaison VPC à bloquer, où chaque point de terminaison VPC est spécifié comme une référence telle qu'une Référence dynamique ou la fonction intrinsèque Ref.

Type : liste

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

IntrinsicVpceWhitelist

Liste des points de terminaison VPC à autoriser, où chaque point de terminaison VPC est spécifié en tant que référence telle qu'une Référence dynamique ou la fonction intrinsèque Ref. Pour obtenir un exemple d'utilisation de cette propriété, consultez la section Exemples en bas de cette page.

Type : liste

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

IpRangeBlacklist

L'adresse IP ou les plages d'adresses à bloquer. Pour obtenir un exemple d'utilisation de cette propriété, consultez la section Exemples en bas de cette page.

Type : liste

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

IpRangeWhitelist

L'adresse IP ou les plages d'adresses à autoriser.

Type : liste

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

SourceVpcBlacklist

Les points de terminaison VPC ou VPC source à bloquer. Les noms de VPC source doivent commencer par "vpc-" et les noms de point de terminaison VPC source doivent commencer par "vpce-". Pour obtenir un exemple d'utilisation de cette propriété, consultez la section Exemples en bas de cette page.

Type : liste

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

SourceVpcWhitelist

Les points de terminaison VPC ou VPC source à autoriser. Les noms de VPC source doivent commencer par "vpc-" et les noms de point de terminaison VPC source doivent commencer par "vpce-".

Type : liste

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

Exemples

Exemples de stratégie basée sur les ressources

L'exemple suivant bloque deux adresses IP et un VPC source, et autorise un AWS compte.

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