Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
Configura una política de recursos para todos los métodos y rutas de una API. Para obtener más información sobre las políticas de recursos, consulta Controlar el acceso a una API con las políticas de recursos de API Gateway en la Guía para desarrolladores de API Gateway.
Sintaxis
Para declarar esta entidad en tu plantilla AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis.
YAML
AwsAccountBlacklist: List
AwsAccountWhitelist: List
CustomStatements: List
IntrinsicVpcBlacklist: List
IntrinsicVpcWhitelist: List
IntrinsicVpceBlacklist: List
IntrinsicVpceWhitelist: List
IpRangeBlacklist: List
IpRangeWhitelist: List
SourceVpcBlacklist: List
SourceVpcWhitelist: List
Propiedades
-
AwsAccountBlacklist -
Las AWS cuentas que se van a bloquear.
Tipo: lista de cadena
Obligatorio: no
AWS CloudFormation compatibilidad: esta propiedad es exclusiva AWS SAM y no tiene un AWS CloudFormation equivalente.
-
AwsAccountWhitelist -
Las AWS cuentas que se van a permitir. Para obtener un ejemplo del uso de esta propiedad, consulta la sección Ejemplos al final de esta página.
Tipo: lista de cadena
Obligatorio: no
AWS CloudFormation compatibilidad: esta propiedad es exclusiva de AWS SAM y no tiene un AWS CloudFormation equivalente.
-
CustomStatements -
Una lista de instrucciones de política de recursos personalizadas para aplicarlas a esta API. Para obtener un ejemplo del uso de esta propiedad, consulta la sección Ejemplos al final de esta página.
Tipo: lista
Obligatorio: no
AWS CloudFormation compatibilidad: esta propiedad es exclusiva de AWS SAM y no tiene un AWS CloudFormation equivalente.
-
IntrinsicVpcBlacklist -
La lista de nubes privadas virtuales (VPCs) que se van a bloquear, donde cada VPC se especifica como referencia, por ejemplo, una referencia dinámica o la función
Refintrínseca. Para obtener un ejemplo del uso de esta propiedad, consulta la sección Ejemplos al final de esta página.Tipo: lista
Obligatorio: no
AWS CloudFormation compatibilidad: esta propiedad es exclusiva AWS SAM y no tiene un AWS CloudFormation equivalente.
-
IntrinsicVpcWhitelist -
La lista de VPCs permitidos, donde cada VPC se especifica como una referencia, como una referencia dinámica o la función
Refintrínseca.Tipo: lista
Obligatorio: no
AWS CloudFormation compatibilidad: esta propiedad es exclusiva AWS SAM y no tiene un AWS CloudFormation equivalente.
-
IntrinsicVpceBlacklist -
La lista de puntos de conexión de VPC que se van a bloquear, donde cada punto de conexión de VPC se especifica como referencia, por ejemplo, una referencia dinámica o la función intrínseca
Ref.Tipo: lista
Obligatorio: no
AWS CloudFormation compatibilidad: esta propiedad es exclusiva de AWS SAM y no tiene un AWS CloudFormation equivalente.
-
IntrinsicVpceWhitelist -
La lista de nubes privadas virtuales (VPC) permitidas, donde cada punto de conexión de VPC se especifica como referencia, por ejemplo, una referencia dinámica o la función intrínseca
Ref. Para obtener un ejemplo del uso de esta propiedad, consulta la sección Ejemplos al final de esta página.Tipo: lista
Obligatorio: no
AWS CloudFormation compatibilidad: esta propiedad es exclusiva de AWS SAM y no tiene un AWS CloudFormation equivalente.
-
IpRangeBlacklist -
Las direcciones IP o los rangos de direcciones que se van a bloquear. Para obtener un ejemplo del uso de esta propiedad, consulta la sección Ejemplos al final de esta página.
Tipo: lista
Obligatorio: no
AWS CloudFormation compatibilidad: esta propiedad es exclusiva de AWS SAM y no tiene un AWS CloudFormation equivalente.
-
IpRangeWhitelist -
Las direcciones IP o los rangos de direcciones que se van a permitir.
Tipo: lista
Obligatorio: no
AWS CloudFormation compatibilidad: esta propiedad es exclusiva de AWS SAM y no tiene un AWS CloudFormation equivalente.
-
SourceVpcBlacklist -
La VPC de origen o los puntos de conexión de VPC que se van a bloquear. Los nombres de la VPC de origen deben empezar por
"vpc-"y los nombres de los puntos de conexión de VPC de origen deben empezar por"vpce-". Para obtener un ejemplo del uso de esta propiedad, consulta la sección Ejemplos al final de esta página.Tipo: lista
Obligatorio: no
AWS CloudFormation compatibilidad: esta propiedad es exclusiva de AWS SAM y no tiene un AWS CloudFormation equivalente.
-
SourceVpcWhitelist -
La VPC de origen o los puntos de conexión de VPC que se van a permitir. Los nombres de la VPC de origen deben empezar por
"vpc-"y los nombres de los puntos de conexión de VPC de origen deben empezar por"vpce-".Tipo: lista
Obligatorio: no
AWS CloudFormation compatibilidad: esta propiedad es exclusiva de AWS SAM y no tiene un AWS CloudFormation equivalente.
Ejemplos
Ejemplo de política de recursos
El siguiente ejemplo bloquea dos direcciones IP y una VPC de origen y permite una AWS cuenta.
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
