How AWS IoT Things Graph works with IAM - AWS IoT Things Graph

How AWS IoT Things Graph works with IAM

Before you use IAM to manage access to AWS IoT Things Graph, you should understand what IAM features are available to use with AWS IoT Things Graph. To get a high-level view of how AWS IoT Things Graph and other AWS services work with IAM, see AWS services that work with IAM in the IAM User Guide.

AWS IoT Things Graph identity-based policies

With IAM identity-based policies, you can specify allowed or denied actions and resources as well as the conditions under which actions are allowed or denied. AWS IoT Things Graph supports specific actions, resources, and condition keys. To learn about all of the elements that you use in a JSON policy, see IAM JSON policy elements reference in the IAM User Guide.

Actions

Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions.

The Action element of a JSON policy describes the actions that you can use to allow or deny access in a policy. Policy actions usually have the same name as the associated AWS API operation. There are some exceptions, such as permission-only actions that don't have a matching API operation. There are also some operations that require multiple actions in a policy. These additional actions are called dependent actions.

Include actions in a policy to grant permissions to perform the associated operation.

The AWS IoT Things Graph control plane uses IAM policies to define what a user can do. You can create policies that assign permissions for all actions in the AWS IoT Things Graph API Reference.

For example, the following policy assigns permission for a user to use the CreateSystemInstance API.

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "iotthingsgraph:CreateSystemInstance" ], "Resource": [ "*" ] } ] }

The following policy gives permission to perform all actions.

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "iotthingsgraph:*" ], "Resource": [ "*" ] } ] }

Policy actions in AWS IoT Things Graph use the following prefix before the action: iotthingsgraph:. For example, to grant someone permission to upload iotthingsgraph entities with the AWS IoT Things Graph UploadEntityDefinitions API operation, you include the iotthingsgraph:UploadEntityDefinitions action in the policy. Policy statements must include an Action or NotAction element. AWS IoT Things Graph defines its own set of actions that describe tasks that you can perform with this service.

To specify multiple actions in a single statement, separate them with commas as follows.

"Action": [ "iotthingsgraph:action1", "iotthingsgraph:action2"

You can specify multiple actions using wildcards (*). For example, to specify all actions that begin with the word Create, include the following action.

"Action": "iotthingsgraph:Create*"

To see a list of AWS IoT Things Graph actions, see Actions Defined by AWS IoT Things Graph in the IAM User Guide.

Resources

Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions.

The Resource JSON policy element specifies the object or objects to which the action applies. Statements must include either a Resource or a NotResource element. As a best practice, specify a resource using its Amazon Resource Name (ARN). You can do this for actions that support a specific resource type, known as resource-level permissions.

For actions that don't support resource-level permissions, such as listing operations, use a wildcard (*) to indicate that the statement applies to all resources.

"Resource": "*"

The AWS IoT Things Graph workflow (flow) instance resource has the following ARN.

arn:${Partition}:iotthingsgraph:${Region}:${Account}:workflow/${WorkflowName}

For more information about the format of ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference.

For example, to specify the SecurityFlow flow in your statement, use the following ARN.

"Resource": "arn:aws:iotthingsgraph:us-east-1:123456789012:workflow/SecurityFlow"

To specify all flows that belong to a specific account, use the wildcard (*).

"Resource": "arn:aws:iotthingsgraph:us-east-1:123456789012:workflow/*"

Some AWS IoT Things Graph actions, such as those for creating resources, can't be performed on a specific resource. In those cases, you must use the wildcard (*).

"Resource": "*"

To specify multiple resources in a single statement, separate the ARNs with commas.

"Resource": [ "resource1", "resource2"

To see a list of AWS IoT Things Graph resource types and their ARNs, see Resources Defined by AWS IoT Things Graph in the IAM User Guide. To learn with which actions you can specify the ARN of each resource, see Actions Defined by AWS IoT Things Graph.

Condition keys

Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions.

The Condition element (or Condition block) lets you specify conditions in which a statement is in effect. The Condition element is optional. You can create conditional expressions that use condition operators, such as equals or less than, to match the condition in the policy with values in the request.

If you specify multiple Condition elements in a statement, or multiple keys in a single Condition element, AWS evaluates them using a logical AND operation. If you specify multiple values for a single condition key, AWS evaluates the condition using a logical OR operation. All of the conditions must be met before the statement's permissions are granted.

You can also use placeholder variables when you specify conditions. For example, you can grant an IAM user permission to access a resource only if it is tagged with their IAM user name. For more information, see IAM policy elements: variables and tags in the IAM User Guide.

AWS supports global condition keys and service-specific condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide.

AWS IoT Things Graph defines its own set of condition keys and also supports using some global condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide.

To see a list of AWS IoT Things Graph condition keys, see Condition Keys for AWS IoT Things Graph in the IAM User Guide. To learn with which actions and resources you can use a condition key, see Actions Defined by AWS IoT Things Graph.

Examples

To view examples of AWS IoT Things Graph identity-based policies, see AWS IoT Things Graph identity-based policy examples.

AWS IoT Things Graph resource-based policies

Resource-based policies are JSON policy documents that specify what actions a specified principal can perform on the AWS IoT Things Graph resource and under what conditions. AWS IoT Things Graph doesn't support IAM resource-based policies.

Access control lists

Access control lists (ACLs) are lists of grantees that you can attach to resources. AWS IoT Things Graph doesn't support ACLs.

Authorization based on AWS IoT Things Graph tags

You can attach tags to AWS IoT Things Graph resources or pass tags in a request to AWS IoT Things Graph. To control access based on tags, you provide tag information in the condition element of a policy using the iotthingsgraph:ResourceTag/key-name, aws:RequestTag/key-name, or aws:TagKeys condition keys. For more information about tagging AWS IoT Things Graph resources, see Tagging your AWS IoT Things Graph resources.

To view an example identity-based policy for limiting access to a resource based on the tags on that resource, see Viewing AWS IoT Things Graph flow configurations based on tags.

AWS IoT Things Graph IAM roles

An IAM role is an entity within your AWS account that has specific permissions.

Using temporary credentials with AWS IoT Things Graph

You can use temporary credentials to sign in with federation, assume an IAM role, or to assume a cross-account role. You obtain temporary security credentials by calling AWS STS API operations such as AssumeRole or GetFederationToken.

AWS IoT Things Graph supports using temporary credentials.

Service-linked roles

Service-linked roles allow AWS services to access resources in other services to complete an action on your behalf. AWS IoT Things Graph doesn't support service-linked roles.

Service roles

This feature allows a service to assume a service role on your behalf. This role allows the service to access resources in other services to complete an action on your behalf. Service roles appear in your IAM account and are owned by the account. This means that an IAM administrator can change the permissions for this role. However, doing so might break the functionality of the service.

AWS IoT Things Graph supports service roles.