Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. iot
  5. Policy
AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-aws

aws.iot.Policy

Explore with Pulumi AI

AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-aws

Provides an IoT policy.

NOTE on policy versions: Updating this resource creates a new, default policy version. If updating the resource would exceed the maximum number of versions (5), the oldest non-default version of the policy is deleted before the new policy version is created.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const pubsub = new aws.iot.Policy("pubsub", {
    name: "PubSubToAnyTopic",
    policy: JSON.stringify({
        Version: "2012-10-17",
        Statement: [{
            Action: ["iot:*"],
            Effect: "Allow",
            Resource: "*",
        }],
    }),
});
Copy
import pulumi
import json
import pulumi_aws as aws

pubsub = aws.iot.Policy("pubsub",
    name="PubSubToAnyTopic",
    policy=json.dumps({
        "Version": "2012-10-17",
        "Statement": [{
            "Action": ["iot:*"],
            "Effect": "Allow",
            "Resource": "*",
        }],
    }))
Copy
package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iot"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"Version": "2012-10-17",
			"Statement": []map[string]interface{}{
				map[string]interface{}{
					"Action": []string{
						"iot:*",
					},
					"Effect":   "Allow",
					"Resource": "*",
				},
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = iot.NewPolicy(ctx, "pubsub", &iot.PolicyArgs{
			Name:   pulumi.String("PubSubToAnyTopic"),
			Policy: pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var pubsub = new Aws.Iot.Policy("pubsub", new()
    {
        Name = "PubSubToAnyTopic",
        PolicyDocument = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["Version"] = "2012-10-17",
            ["Statement"] = new[]
            {
                new Dictionary<string, object?>
                {
                    ["Action"] = new[]
                    {
                        "iot:*",
                    },
                    ["Effect"] = "Allow",
                    ["Resource"] = "*",
                },
            },
        }),
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iot.Policy;
import com.pulumi.aws.iot.PolicyArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var pubsub = new Policy("pubsub", PolicyArgs.builder()
            .name("PubSubToAnyTopic")
            .policy(serializeJson(
                jsonObject(
                    jsonProperty("Version", "2012-10-17"),
                    jsonProperty("Statement", jsonArray(jsonObject(
                        jsonProperty("Action", jsonArray("iot:*")),
                        jsonProperty("Effect", "Allow"),
                        jsonProperty("Resource", "*")
                    )))
                )))
            .build());

    }
}
Copy
resources:
  pubsub:
    type: aws:iot:Policy
    properties:
      name: PubSubToAnyTopic
      policy:
        fn::toJSON:
          Version: 2012-10-17
          Statement:
            - Action:
                - iot:*
              Effect: Allow
              Resource: '*'
Copy

Create Policy Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Policy(name: string, args: PolicyArgs, opts?: CustomResourceOptions);
@overload
def Policy(resource_name: str,
           args: PolicyArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Policy(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           policy: Optional[str] = None,
           name: Optional[str] = None,
           tags: Optional[Mapping[str, str]] = None)
func NewPolicy(ctx *Context, name string, args PolicyArgs, opts ...ResourceOption) (*Policy, error)
public Policy(string name, PolicyArgs args, CustomResourceOptions? opts = null)
public Policy(String name, PolicyArgs args)
public Policy(String name, PolicyArgs args, CustomResourceOptions options)

type: aws:iot:Policy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PolicyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PolicyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var examplepolicyResourceResourceFromIotpolicy = new Aws.Iot.Policy("examplepolicyResourceResourceFromIotpolicy", new()
{
    PolicyDocument = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := iot.NewPolicy(ctx, "examplepolicyResourceResourceFromIotpolicy", &iot.PolicyArgs{
	Policy: pulumi.String("string"),
	Name:   pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var examplepolicyResourceResourceFromIotpolicy = new Policy("examplepolicyResourceResourceFromIotpolicy", PolicyArgs.builder()
    .policy("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
examplepolicy_resource_resource_from_iotpolicy = aws.iot.Policy("examplepolicyResourceResourceFromIotpolicy",
    policy="string",
    name="string",
    tags={
        "string": "string",
    })
Copy
const examplepolicyResourceResourceFromIotpolicy = new aws.iot.Policy("examplepolicyResourceResourceFromIotpolicy", {
    policy: "string",
    name: "string",
    tags: {
        string: "string",
    },
});
Copy
type: aws:iot:Policy
properties:
    name: string
    policy: string
    tags:
        string: string
Copy

Policy Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Policy resource accepts the following input properties:

PolicyDocument This property is required. string
The policy document. This is a JSON formatted string. Use the IoT Developer Guide for more information on IoT Policies.
Name Changes to this property will trigger replacement. string
The name of the policy.
Tags Dictionary<string, string>
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Policy This property is required. string
The policy document. This is a JSON formatted string. Use the IoT Developer Guide for more information on IoT Policies.
Name Changes to this property will trigger replacement. string
The name of the policy.
Tags map[string]string
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
policy This property is required. String
The policy document. This is a JSON formatted string. Use the IoT Developer Guide for more information on IoT Policies.
name Changes to this property will trigger replacement. String
The name of the policy.
tags Map<String,String>
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
policy This property is required. string
The policy document. This is a JSON formatted string. Use the IoT Developer Guide for more information on IoT Policies.
name Changes to this property will trigger replacement. string
The name of the policy.
tags {[key: string]: string}
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
policy This property is required. str
The policy document. This is a JSON formatted string. Use the IoT Developer Guide for more information on IoT Policies.
name Changes to this property will trigger replacement. str
The name of the policy.
tags Mapping[str, str]
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
policy This property is required. String
The policy document. This is a JSON formatted string. Use the IoT Developer Guide for more information on IoT Policies.
name Changes to this property will trigger replacement. String
The name of the policy.
tags Map<String>
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

All input properties are implicitly available as output properties. Additionally, the Policy resource produces the following output properties:

Arn string
The ARN assigned by AWS to this policy.
DefaultVersionId string
The default version of this policy.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
The ARN assigned by AWS to this policy.
DefaultVersionId string
The default version of this policy.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll map[string]string
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The ARN assigned by AWS to this policy.
defaultVersionId String
The default version of this policy.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
The ARN assigned by AWS to this policy.
defaultVersionId string
The default version of this policy.
id string
The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
The ARN assigned by AWS to this policy.
default_version_id str
The default version of this policy.
id str
The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The ARN assigned by AWS to this policy.
defaultVersionId String
The default version of this policy.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up Existing Policy Resource

Get an existing Policy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PolicyState, opts?: CustomResourceOptions): Policy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        default_version_id: Optional[str] = None,
        name: Optional[str] = None,
        policy: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Policy
func GetPolicy(ctx *Context, name string, id IDInput, state *PolicyState, opts ...ResourceOption) (*Policy, error)
public static Policy Get(string name, Input<string> id, PolicyState? state, CustomResourceOptions? opts = null)
public static Policy get(String name, Output<String> id, PolicyState state, CustomResourceOptions options)
resources:  _:    type: aws:iot:Policy    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string
The ARN assigned by AWS to this policy.
DefaultVersionId string
The default version of this policy.
Name Changes to this property will trigger replacement. string
The name of the policy.
PolicyDocument string
The policy document. This is a JSON formatted string. Use the IoT Developer Guide for more information on IoT Policies.
Tags Dictionary<string, string>
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
The ARN assigned by AWS to this policy.
DefaultVersionId string
The default version of this policy.
Name Changes to this property will trigger replacement. string
The name of the policy.
Policy string
The policy document. This is a JSON formatted string. Use the IoT Developer Guide for more information on IoT Policies.
Tags map[string]string
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The ARN assigned by AWS to this policy.
defaultVersionId String
The default version of this policy.
name Changes to this property will trigger replacement. String
The name of the policy.
policy String
The policy document. This is a JSON formatted string. Use the IoT Developer Guide for more information on IoT Policies.
tags Map<String,String>
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
The ARN assigned by AWS to this policy.
defaultVersionId string
The default version of this policy.
name Changes to this property will trigger replacement. string
The name of the policy.
policy string
The policy document. This is a JSON formatted string. Use the IoT Developer Guide for more information on IoT Policies.
tags {[key: string]: string}
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
The ARN assigned by AWS to this policy.
default_version_id str
The default version of this policy.
name Changes to this property will trigger replacement. str
The name of the policy.
policy str
The policy document. This is a JSON formatted string. Use the IoT Developer Guide for more information on IoT Policies.
tags Mapping[str, str]
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The ARN assigned by AWS to this policy.
defaultVersionId String
The default version of this policy.
name Changes to this property will trigger replacement. String
The name of the policy.
policy String
The policy document. This is a JSON formatted string. Use the IoT Developer Guide for more information on IoT Policies.
tags Map<String>
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Import

Using pulumi import, import IoT policies using the name. For example:

$ pulumi import aws:iot/policy:Policy pubsub PubSubToAnyTopic
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-aws