As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
ResourcePolicyStatement
Configura uma política de recursos para todos os métodos e caminhos de uma API. Para obter mais informações sobre políticas de recursos, consulte Como controlar o acesso a uma API com as políticas de recursos do API Gateway no Guia do desenvolvedor do API Gateway.
Sintaxe
Para declarar esta entidade no modelo do AWS Serverless Application Model (AWS SAM), use a seguinte sintaxe:
YAML
AwsAccountBlacklist:
List
AwsAccountWhitelist:List
CustomStatements:List
IntrinsicVpcBlacklist:List
IntrinsicVpcWhitelist:List
IntrinsicVpceBlacklist:List
IntrinsicVpceWhitelist:List
IpRangeBlacklist:List
IpRangeWhitelist:List
SourceVpcBlacklist:List
SourceVpcWhitelist:List
Propriedades
-
AwsAccountBlacklist
-
As AWS contas a serem bloqueadas.
Tipo: lista de strings
Obrigatório: não
Compatibilidade AWS CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem AWS CloudFormation equivalente.
-
AwsAccountWhitelist
-
As contas AWS a serem permitidas. Para obter um exemplo de uso desta propriedade, consulte a seção Exemplos na parte inferior desta página.
Tipo: lista de strings
Obrigatório: não
Compatibilidade AWS CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem AWS CloudFormation equivalente.
-
CustomStatements
-
Uma lista de declarações de política de recursos personalizadas a serem aplicadas a essa API. Para obter um exemplo de uso desta propriedade, consulte a seção Exemplos na parte inferior desta página.
Tipo: lista
Obrigatório: não
Compatibilidade AWS CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem AWS CloudFormation equivalente.
-
IntrinsicVpcBlacklist
-
A lista de nuvens privadas virtuais (VPCs) a serem bloqueadas, onde cada VPC é especificada como uma referência, como uma referência dinâmica ou a
Ref
função intrínseca. Para obter um exemplo de uso desta propriedade, consulte a seção Exemplos na parte inferior desta página.Tipo: lista
Obrigatório: não
Compatibilidade AWS CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem AWS CloudFormation equivalente.
-
IntrinsicVpcWhitelist
-
A lista de VPCs a serem permitidos, em que cada VPC é especificado como uma referência, como uma referência dinâmica ou a
Ref
função intrínseca.Tipo: lista
Obrigatório: não
Compatibilidade AWS CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem AWS CloudFormation equivalente.
-
IntrinsicVpceBlacklist
-
A lista de endpoints da VPC a serem bloqueados, em que cada endpoint da VPC é especificado como uma referência, como uma referência dinâmica ou a
Ref
função intrínseca.Tipo: lista
Obrigatório: não
Compatibilidade AWS CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem AWS CloudFormation equivalente.
-
IntrinsicVpceWhitelist
-
A lista de endpoints da VPC a serem permitidos, em que cada endpoint da VPC é especificado como uma referência, como uma referência dinâmica ou a
Ref
função intrínseca. Para obter um exemplo de uso desta propriedade, consulte a seção Exemplos na parte inferior desta página.Tipo: lista
Obrigatório: não
Compatibilidade AWS CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem AWS CloudFormation equivalente.
-
IpRangeBlacklist
-
Os endereços IP ou intervalos de endereços a serem bloqueados. Para obter um exemplo de uso desta propriedade, consulte a seção Exemplos na parte inferior desta página.
Tipo: lista
Obrigatório: não
Compatibilidade AWS CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem AWS CloudFormation equivalente.
-
IpRangeWhitelist
-
Os endereços IP ou intervalos de endereços a serem permitidos.
Tipo: lista
Obrigatório: não
Compatibilidade AWS CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem AWS CloudFormation equivalente.
-
SourceVpcBlacklist
-
A VPC de origem ou os endpoints da VPC a serem bloqueados. Os nomes da VPC de origem devem começar com
"vpc-"
e os nomes dos endpoints da VPC de origem devem começar com"vpce-"
. Para obter um exemplo de uso desta propriedade, consulte a seção Exemplos na parte inferior desta página.Tipo: lista
Obrigatório: não
Compatibilidade AWS CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem AWS CloudFormation equivalente.
-
SourceVpcWhitelist
-
A VPC de origem ou os endpoints da VPC a serem permitidos. Os nomes da VPC de origem devem começar com
"vpc-"
e os nomes dos endpoints da VPC de origem devem começar com"vpce-"
.Tipo: lista
Obrigatório: não
Compatibilidade AWS CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem AWS CloudFormation equivalente.
Exemplos
Exemplo de política de recursos
O exemplo a seguir bloqueia dois endereços IP e uma VPC de origem e permite uma conta 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