CDK.IAM.Floyd 0.850.0

IAM Floyd

AWS IAM policy statement generator with a fluent interface, for TypeScript, JavaScript, Python, Java, C# and Go.

IAM Floyd has a class for every AWS service, with a method for every action, resource type and condition key. Your IDE completes them and shows their documentation, so you neither look up action names and ARN formats, nor deploy policies with typos.

import { Statement } from 'iam-floyd';

const statement = new Statement.Ec2()
  .allow()
  .toStartInstances()
  .toStopInstances()
  .ifResourceTag('Owner', '${aws:username}');

{
  "Condition": {
    "StringLike": {
      "ec2:ResourceTag/Owner": "${aws:username}"
    }
  },
  "Action": ["ec2:StartInstances", "ec2:StopInstances"],
  "Resource": "*",
  "Effect": "Allow"
}

<details> <summary>Python</summary>

from iam_floyd import Statement

statement = (
    Statement.Ec2()
        .allow()
        .to_start_instances()
        .to_stop_instances()
        .if_resource_tag('Owner', '${aws:username}')
)

</details><details> <summary>Java</summary>

import com.udondan.iamFloyd.statement.Ec2;

Ec2 statement = new Ec2()
    .allow()
    .toStartInstances()
    .toStopInstances()
    .ifResourceTag("Owner", "${aws:username}");

</details><details> <summary>C#</summary>

using Statement = IAM.Floyd.Statement;

var statement = new Statement.Ec2()
    .Allow()
    .ToStartInstances()
    .ToStopInstances()
    .IfResourceTag("Owner", "${aws:username}");

</details><details> <summary>Go</summary>

import (
	"udondan.github.io/iam-floyd/go/iamfloyd"
	"udondan.github.io/iam-floyd/go/iamfloyd/statement"
)

s := statement.NewEc2(nil).
	Allow().
	ToStartInstances().
	ToStopInstances().
	IfResourceTag(iamfloyd.String("Owner"), iamfloyd.String("${aws:username}"), nil)

</details>

Support for:

• 455 Services
• 22036 Actions
• 2329 Resource Types
• 2497 Condition keys

Features

• Complete: generated from the AWS documentation, and updated every week
• Access levels: add all actions of an access level, e.g. allReadActions() or allWriteActions()
• Regular expressions: add all actions that match a pattern with allMatchingActions('/vpn/i')
• Resources: build ARNs with a method per resource type, e.g. onBucket('example-bucket'), with defaults for partition, region and account
• Conditions: a method per condition key, with operators like ForAnyValue:StringEquals or IfExists
• AWS CDK: cdk-iam-floyd statements are an iam.PolicyStatement of the AWS CDK
• Collections of common statements, and the names of all AWS managed policies
• Policy converter: turn an existing JSON policy into IAM Floyd code with the online converter

Packages

IAM Floyd comes in two variants, with the same API and the same version number in every language:

• iam-floyd creates statements as JSON, for the AWS SDKs, CloudFormation, Terraform or anything else that takes an IAM policy. The packages have no dependencies. In Python, Java, C# and Go, they are native and do not need Node.js.
• cdk-iam-floyd creates statements of the AWS CDK v2. In Python, Java, C# and Go, they are built with jsii, like the AWS CDK itself, and need Node.js.

Language	iam-floyd	cdk-iam-floyd
TypeScript / JavaScript
Python
Java
C# / .NET
Go

Installation

# TypeScript / JavaScript
npm install iam-floyd           # or cdk-iam-floyd

# Python
pip install iam-floyd           # or cdk-iam-floyd

# Java (Maven), with the version of the release
#   com.udondan:iam-floyd       # or com.udondan:cdk-iam-floyd

# C# / .NET
dotnet add package IAM.Floyd    # or CDK.IAM.Floyd

# Go
go get udondan.github.io/iam-floyd/go/iamfloyd   # or .../go/cdkiamfloyd

IAM Floyd has not reached 1.0.0 yet, and the API can still change between releases. Pin the exact version.

The requirements of each package and the compatibility with the AWS CDK are listed in the documentation.

Documentation

The documentation explains all features, with examples in every language.

Legal

The service models in the lib/generated/model folder, and the code generated from them, are derived from the AWS documentation. The class- and function-names and their description therefore are property of AWS.

AWS and their services are trademarks, registered trademarks or trade dress of AWS in the U.S. and/or other countries.

This project is not affiliated, funded, or in any way associated with AWS.

IAM Floyd is licensed under Apache License 2.0. Dependencies might be released under different licenses.