DEV Community

Yutaro Mori
Yutaro Mori

Posted on • Edited on

What is IAM instance profile?

Introduction

You attach IAM role with IAM policy to AWS resources which granted to operate the other AWS Resources.

image1

However, EC2 is not attached to IAM role, but is attached to IAM instance profile.

image2

image3

In AWS CLI, There is the parameter about IamInstanceProfile, too.

 aws ec2 describe-instances --query "Reservations[].Instances[].IamInstanceProfile.Arn"
[
    "arn:aws:iam::XXXXXXXXXXXX:instance-profile/Yuta20210911"
]
Enter fullscreen mode Exit fullscreen mode

So, what is the IAM instance profile?

About IAM instance profile

https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html

I found the following description in the AWS documentation.

Amazon EC2 uses an instance profile as a container for an IAM role. When you create an IAM role using the IAM console, the console creates an instance profile automatically and gives it the same name as the role to which it corresponds. If you use the Amazon EC2 console to launch an instance with an IAM role or to attach an IAM role to an instance, you choose the role based on a list of instance profile names.

Instance profile is the container stored the IAM role and described as attaching that container to EC2 in the document. It is the concept used only in EC2, and when you create IAM role, is created same name automatically. You don't have to be aware of the difference between IAM Instance profile and IAM role. At the important point, it is the case of Infrastructure as Code(IaC)

Points to note when developing IaC

When you attach IAM roles to Lambda or CodePipeline, write Arn of IAM roles in role parameter by CloudFormation or Terraform.

To create Lambda by IaC

# CloudFormation template file
AWSTemplateFormatVersion: '2010-09-09'
Resources:
  LambdaFunction:
    Type: 'AWS::Lambda::Function'
    Properties:
      FunctionName: 'efs-s3'
      Role: !GetAtt IAMRole.Arn

  IAMRole:
    Type: 'AWS::IAM::Role'
    Properties:
      Path: '/'
      RoleName: 'efs-S3'
      AssumeRolePolicyDocument:
        Version:'2012-10-17'
        Statement:
          - Effect:Allow
            Principal:
            Service:
              - lambda.amazonaws.com
            Action:
              - 'sts:AssumeRole'
Enter fullscreen mode Exit fullscreen mode
# Terraform tf file
resource "aws_lambda_function" "LambdaFunction" {
    function_name = "efs-s3"
    role = "${aws_iam_role.IAMRole.arn}"
}

resource "aws_iam_role" "IAMRole" {
    path = "/"
    name = "efs-S3"
    assume_role_policy = jsonencode({
    "Version": "2012-10-17",
    "Statement": [
      {
        "Effect": "Allow",
        "Principal": {
          "Service": "lambda.amazonaws.com"
        },
        "Action": "sts:AssumeRole"
      }
    ]
    })
}
Enter fullscreen mode Exit fullscreen mode

Passing on Arn info of IAM role created to the other AWS resources, the AWS resources are given to permissions to operate ones. On the other hands, what passing on to EC2 for IAM permission is not IAM role, but IAM instance profile. You have to create IAM instance profile expressly to create EC2 by IaC.

To create EC2 by IaC

# CloudFormation template file
AWSTemplateFormatVersion: '2010-09-09'
Resources:
    EC2Instance:
        Type: 'AWS::EC2::Instance'
        Properties:
            IamInstanceProfile: !Ref IAMRole
            Tags:
              - Key: "Name"
                Value: "Test"

    IAMRole:
        Type: 'AWS::IAM::Role'
        Properties:
            Path: '/'
            RoleName: 'Yuta20220815'
            AssumeRolePolicyDocument:
              Version:2012-10-17
              Statement:
                 - Effect:Allow
                   Principal:
                     Service:
                       - ec2.amazonaws.com
                     Action:
                       - sts:AssumeRole

    # Need to create an IAM instance profile
    IAMInstanceProfile:
        Type: 'AWS::IAM::InstanceProfile'
        Properties:
            Path: '/'
            InstanceProfileName: !Ref IAMRole
            Roles:
              - !Ref IAMRole
Enter fullscreen mode Exit fullscreen mode
# Terraform tf file
resource "aws_instance" "EC2Instance" {
    tags = {
        Name = "Test"
    }
    iam_instance_profile = aws_iam_role.IAMRole.name
}

resource "aws_iam_role" "IAMRole" {
    path = "/"
    name = "Yuta20220815"
    assume_role_policy = jsonencode({
        Version = "2012-10-17"
        Statement = [
            {
                Effect = "Allow"
                Principal = {
                    Service = "ec2.amazonaws.com"
                }
                Action = "sts:AssumeRole"
            }
        ]
    })
}

# Need to create an IAM instance profile
resource "aws_iam_instance_profile" "IAMInstanceProfile" {
    path = "/"
    name = aws_iam_role.IAMRole.name
    role = aws_iam_role.IAMRole.name
}
Enter fullscreen mode Exit fullscreen mode

If you deploy code that creates only EC2 and IAM role without creating IAM instance profile, you would get an error.

image4

│ Error: creating EC2 Instance: InvalidParameterValue: Value (Yuta20220815) for parameter iamInstanceProfile.name is invalid. Invalid IAM Instance Profile name
│       status code: 400, request id: 7fe3f4c5-b023-40e9-8d31-69e799d5b18a
│
│   with aws_instance.EC2Instance,
│   on ec2.tf line 1, in resource "aws_instance" "EC2Instance":
│    1: resource "aws_instance" "EC2Instance" {
Enter fullscreen mode Exit fullscreen mode

Therefore, when you create EC2 by IaC, you need to create IAM instance profile expressly.

Conclusion

I introduce IAM instance profile. When we pass on the permission of IAM role to EC2 from AWS console, we are not aware of IAM instance profile because we choose IAM role. However, there are prone to errors to create AWS resource by IaC and you should pay attention to them. I don't find the reason why EC2 are passed on IAM instance profile to not IAM role.

According to this article, IAM instance profile defines "who am I?". Just like an IAM user represents a person, an instance profile represents EC2 instances.

An instance profile, on the other hand, defines “who am I?” Just like an IAM user represents a person, an instance profile represents EC2 instances. The only permissions an EC2 instance profile has is the power to assume a role.

However, among the many AWS resources, I couldn't tell if EC2 is the only one that explicitly defines the target audience in the IAM instance profile.

Please comment me if you know the reasons.

Original

https://zenn.dev/yuta28/articles/ec2-iam-instance-profile

Top comments (2)

Collapse
 
joshua_omolewa_f4b5b20aa1 profile image
Joshua Omolewa • Edited

Your cloud formation code and terraform code for creating ec2 is wrong. please fix as the code for lambda function is duplicated

Collapse
 
yuta28 profile image
Yutaro Mori

Thank you for your comment. I fixed it.