Esta es la guía para AWS CDK desarrolladores de la versión 2. La primera versión del CDK pasó a la etapa de mantenimiento el 1.° de junio de 2022 y no cuenta con soporte desde el 1.° de junio de 2023.
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.
La biblioteca AWS Construct utiliza algunos modismos comunes y ampliamente implementados para administrar el acceso y los permisos. El módulo de IAM le proporciona las herramientas que necesita para utilizar estas expresiones idiomáticas.
AWS CDK se utiliza AWS CloudFormation para implementar cambios. Cada implementación involucra a un actor (ya sea un desarrollador o un sistema automatizado) que inicia una AWS CloudFormation implementación. Mientras lo hace, el actor asumirá una o más identidades de IAM (usuario o roles) y, si lo desea, le transferirá un rol. AWS CloudFormation
Si se utiliza AWS IAM Identity Center para autenticarse como usuario, el proveedor de inicio de sesión único proporciona credenciales de sesión de corta duración que le autorizan a actuar como una función de IAM predefinida. Para obtener información sobre cómo AWS CDK obtiene las AWS credenciales de la autenticación del Centro de Identidad de IAM, consulte Cómo entender la autenticación del Centro de Identidad de IAM en la Guía de referencia y herramientas.AWS SDKs
Entidades principales
Un principal de IAM es una AWS entidad autenticada que representa a un usuario, servicio o aplicación a la que puede llamar. AWS APIs La biblioteca AWS Construct permite especificar los directores de varias formas flexibles para permitirles acceder a sus recursos. AWS
En contextos de seguridad, el término “entidad principal” se refiere específicamente a las entidades autenticadas, como los usuarios. Los objetos, como los grupos y los roles, no representan a los usuarios (ni a otras entidades autenticadas), sino que los identifican indirectamente con el fin de concederles permisos.
Por ejemplo, si crea un grupo de IAM, puede conceder al grupo (y, por lo tanto, a sus miembros) acceso para escribir en una tabla de Amazon RDS. Sin embargo, el grupo en sí no es una entidad principal porque no representa a una sola entidad (además, no puede iniciar sesión en un grupo).
En la biblioteca de IAM del CDK, las clases que identifican directa o indirectamente a las entidades principales implementan la interfaz de IPrincipal
, lo que permite que estos objetos se usen de manera indistinta en las políticas de acceso. Sin embargo, no todos son entidades principales desde el punto de vista de la seguridad. Entre estos objetos, se incluyen:
-
Entidades principales de servicio (
new iam.ServicePrincipal('service.amazonaws.com')
) -
Entidades principales federadas (
new iam.FederatedPrincipal('cognito-identity.amazonaws.com')
) -
Entidades principales de cuenta (
new iam.AccountPrincipal('0123456789012'))
) -
Entidades principales de usuario canónico (
new iam.CanonicalUserPrincipal('79a59d[...]7ef2be')
) -
AWS Organizations directores ()
new iam.OrganizationPrincipal('org-id')
-
Entidades principales de ARN arbitrarios (
new iam.ArnPrincipal(res.arn)
) -
iam.CompositePrincipal(principal1, principal2, ...)
para confiar en varias entidades principales
Concesiones
Cada constructo que representa un recurso al que se puede acceder, como un bucket de Amazon S3 o una tabla de Amazon DynamoDB, tiene métodos que conceden acceso a otra entidad. Todos estos métodos tienen nombres que comienzan por grant.
Por ejemplo, los buckets de Amazon S3 tienen los métodos grantRead
y grantReadWrite
(Python: grant_read
, grant_read_write
) para permitir el acceso de lectura y lectura/escritura, respectivamente, de una entidad en el bucket. La entidad no necesita saber exactamente qué permisos de IAM de Amazon S3 son necesarios para realizar estas operaciones.
El primer argumento de un método de concesión es siempre de tipo IGrantable. Esta interfaz representa a las entidades a las que se les pueden conceder permisos. Es decir, representa los recursos con roles, como los objetos de IAM Role
, User
y Group
.
También se pueden conceder permisos a otras entidades. Por ejemplo, más adelante en este tema, mostraremos cómo conceder a un CodeBuild proyecto acceso a un bucket de Amazon S3. Por lo general, el rol asociado se obtiene a través de una propiedad role
de la entidad a la que se concede el acceso.
Los recursos que utilizan roles de ejecución, como lambda.Function
, también implementan IGrantable
, por lo que puede concederles acceso directamente, en lugar de concederle acceso a su rol. Por ejemplo, si bucket
es un bucket de Amazon S3 y function
es una función de Lambda, el siguiente código concede a la función acceso de lectura al bucket.
bucket.grantRead(function);
A veces, los permisos se deben aplicar mientras se implementa la pila. Uno de estos casos se produce cuando concede a un recurso personalizado de AWS CloudFormation acceso a otro recurso. El recurso personalizado se invocará durante la implementación, por lo que debe tener los permisos especificados en el momento de la implementación.
Otro caso es cuando un servicio verifica que el rol que le transfiere tiene aplicadas las políticas correctas. (Varios servicios de AWS lo hacen para asegurarse de que no se olvide de configurar las políticas). En esos casos, la implementación podría fallar si los permisos se aplican demasiado tarde.
Para forzar la aplicación de los permisos de la concesión antes de que se cree otro recurso, puede agregar una dependencia a la propia concesión, como se muestra aquí. Si bien el valor devuelto por los métodos de concesión suele descartarse, de hecho, todos los métodos de concesión devuelven un objeto iam.Grant
.
const grant = bucket.grantRead(lambda);
const custom = new CustomResource(...);
custom.node.addDependency(grant);
Roles
El paquete de IAM contiene un constructo Role
que representa los roles de IAM. El siguiente código crea un nuevo rol, de confianza en el EC2 servicio de Amazon.
import * as iam from 'aws-cdk-lib/aws-iam';
const role = new iam.Role(this, 'Role', {
assumedBy: new iam.ServicePrincipal('ec2.amazonaws.com'), // required
});
Puede agregar permisos para un rol llamando al método addToPolicy
del rol (Python: add_to_policy
) y presentar una PolicyStatement
que defina la regla que se va a agregar. La declaración se agrega a la política predeterminada del rol; si no tiene ninguna, se crea una.
El siguiente ejemplo agrega una declaración de política Deny
al rol para las acciones ec2:SomeAction
y s3:AnotherAction
en los recursos bucket
y otherRole
(Python: other_role
), con la condición de que el servicio autorizado sea AWS CodeBuild.
role.addToPolicy(new iam.PolicyStatement({
effect: iam.Effect.DENY,
resources: [bucket.bucketArn, otherRole.roleArn],
actions: ['ec2:SomeAction', 's3:AnotherAction'],
conditions: {StringEquals: {
'ec2:AuthorizedService': 'codebuild.amazonaws.com',
}}}));
En el ejemplo anterior, hemos creado una nueva PolicyStatement
insertada con la llamada a addToPolicy
(Python: add_to_policy
). También puede presentar una declaración de política existente o una que haya modificado. El PolicyStatementobjeto tiene numerosos métodos para añadir principios, recursos, condiciones y acciones.
Si está utilizando un constructo que requiere un rol para funcionar correctamente, puede optar por una de las siguientes opciones:
-
Presenta un rol existente al crear una instancia del constructo.
-
Deje que el constructo cree un nuevo rol para usted, que confíe en la entidad principal de servicio apropiada. En el ejemplo siguiente se utiliza una construcción de este tipo: un CodeBuild proyecto.
import * as codebuild from 'aws-cdk-lib/aws-codebuild';
// imagine roleOrUndefined is a function that might return a Role object
// under some conditions, and undefined under other conditions
const someRole: iam.IRole | undefined = roleOrUndefined();
const project = new codebuild.Project(this, 'Project', {
// if someRole is undefined, the Project creates a new default role,
// trusting the codebuild.amazonaws.com service principal
role: someRole,
});
Una vez creado el objeto, el rol (ya sea el rol presentado o el predeterminado que crea el constructo) está disponible como la propiedad de role
. Sin embargo, esta propiedad no está disponible en los recursos externos. Por lo tanto, estos constructos tienen un método addToRolePolicy
(Python: add_to_role_policy
).
El método no hace nada si el constructo es un recurso externo y, de lo contrario, llama al método addToPolicy
(Python: add_to_policy
) de la propiedad role
. Esto le ahorrará la molestia de tratar el caso indefinido de forma explícita.
El siguiente ejemplo lo demuestra:
// project is imported into the CDK application
const project = codebuild.Project.fromProjectName(this, 'Project', 'ProjectName');
// project is imported, so project.role is undefined, and this call has no effect
project.addToRolePolicy(new iam.PolicyStatement({
effect: iam.Effect.ALLOW, // ... and so on defining the policy
}));
Políticas de recursos
Algunos recursos AWS, como los buckets de Amazon S3 y las funciones de IAM, también tienen una política de recursos. Estos constructos tienen un método addToResourcePolicy
(Python: add_to_resource_policy
), que toma una PolicyStatement
como argumento. Cada declaración de política agregada a una política de recursos debe especificar al menos una entidad principal.
En el siguiente ejemplo, el bucket de Amazon S3 bucket
otorga un rol con el permiso s3:SomeAction
para sí mismo.
bucket.addToResourcePolicy(new iam.PolicyStatement({
effect: iam.Effect.ALLOW,
actions: ['s3:SomeAction'],
resources: [bucket.bucketArn],
principals: [role]
}));
Uso de objetos de IAM externos
Si ha definido un usuario, director, grupo o rol de IAM fuera de la AWS CDK aplicación, puede usar ese objeto de IAM en la aplicación. AWS CDK Para ello, cree una referencia a él con su ARN o su nombre. (Utilice el nombre para los usuarios, los grupos y los roles). A continuación, la referencia que se obtiene se puede utilizar para conceder permisos o para elaborar declaraciones de políticas, como se ha explicado anteriormente.
-
Para los usuarios, llame a
User.fromUserArn()
oUser.fromUserName()
.User.fromUserAttributes()
también está disponible, pero en este momento ofrece la misma funcionalidad queUser.fromUserArn()
. -
Para las entidades principales, cree una instancia de un objeto
ArnPrincipal
. -
Para grupos, llame a
Group.fromGroupArn()
oGroup.fromGroupName()
. -
Para roles, llame a
Role.fromRoleArn()
oRole.fromRoleName()
.
Las políticas (incluidas las políticas administradas) se pueden utilizar de forma similar mediante los siguientes métodos. Puede utilizar las referencias a estos objetos en cualquier lugar que se requiera una política de IAM.
nota
Como ocurre con todas las referencias a AWS recursos externos, no puedes modificar los objetos de IAM externos en tu aplicación de CDK.