ResourcePolicyStatement

Configura una politica delle risorse per tutti i metodi e i percorsi di un'API. Per ulteriori informazioni sulle politiche delle risorse, consulta Controllare l'accesso a un'API con le politiche delle risorse di API Gateway nella Guida per sviluppatori di API Gateway.

Sintassi

Per dichiarare questa entità nel tuo modello AWS Serverless Application Model (AWS SAM), usa la seguente sintassi.

YAML

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

Proprietà

AwsAccountBlacklist

Gli AWS account da bloccare.

Tipo: elenco di String

Required: No

AWS CloudFormationcompatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

AwsAccountWhitelist

Gli AWS account da consentire. Per un esempio di utilizzo di questa proprietà, consulta la sezione Esempi nella parte inferiore di questa pagina.

Tipo: elenco di String

Required: No

AWS CloudFormationcompatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

CustomStatements

Un elenco di istruzioni personalizzate sulle politiche relative alle risorse da applicare a questa API. Per un esempio di utilizzo di questa proprietà, consulta la sezione Esempi in fondo a questa pagina.

Tipo: Elenco

Required: No

AWS CloudFormationcompatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

IntrinsicVpcBlacklist

L'elenco dei cloud privati virtuali (VPC) da bloccare, in cui ogni VPC è specificato come riferimento, ad esempio un riferimento dinamico o Ref la funzione intrinseca. Per un esempio di utilizzo di questa proprietà, consulta la sezione Esempi in fondo a questa pagina.

Tipo: Elenco

Required: No

AWS CloudFormationcompatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

IntrinsicVpcWhitelist

L'elenco dei VPC da consentire, in cui ogni VPC è specificato come riferimento, ad esempio un riferimento dinamico o Ref una funzione intrinseca.

Tipo: Elenco

Required: No

AWS CloudFormationcompatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

IntrinsicVpceBlacklist

L'elenco degli endpoint VPC da bloccare, in cui ogni endpoint VPC è specificato come riferimento, ad esempio un riferimento dinamico o la funzione intrinseca. Ref

Tipo: Elenco

Required: No

AWS CloudFormationcompatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

IntrinsicVpceWhitelist

L'elenco degli endpoint VPC da consentire, in cui ogni endpoint VPC è specificato come riferimento, ad esempio un riferimento dinamico o la funzione intrinseca. Ref Per un esempio di utilizzo di questa proprietà, consulta la sezione Esempi in fondo a questa pagina.

Tipo: Elenco

Required: No

AWS CloudFormationcompatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

IpRangeBlacklist

Gli indirizzi IP o gli intervalli di indirizzi da bloccare. Per un esempio di utilizzo di questa proprietà, consulta la sezione Esempi nella parte inferiore di questa pagina.

Tipo: Elenco

Required: No

AWS CloudFormationcompatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

IpRangeWhitelist

Gli indirizzi IP o gli intervalli di indirizzi da consentire.

Tipo: Elenco

Required: No

AWS CloudFormationcompatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

SourceVpcBlacklist

Gli endpoint VPC o VPC di origine da bloccare. I nomi degli endpoint VPC di origine devono iniziare con "vpc-" e i nomi degli endpoint VPC di origine devono iniziare con. "vpce-" Per un esempio di utilizzo di questa proprietà, consulta la sezione Esempi nella parte inferiore di questa pagina.

Tipo: Elenco

Required: No

AWS CloudFormationcompatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

SourceVpcWhitelist

Gli endpoint VPC o VPC di origine da consentire. I nomi degli endpoint VPC di origine devono iniziare con "vpc-" e i nomi degli endpoint VPC di origine devono iniziare con. "vpce-"

Tipo: Elenco

Required: No

AWS CloudFormationcompatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

Esempi

Esempio di politica delle risorse

L'esempio seguente blocca due indirizzi IP e un VPC di origine e consente un AWS account.

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