Show / Hide Table of Contents

Class Policy

Provides an IAM policy.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var policy = new Aws.Iam.Policy("policy", new Aws.Iam.PolicyArgs
    {
        Description = "My test policy",
        Path = "/",
        Policy = @"{
""Version"": ""2012-10-17"",
""Statement"": [
{
  ""Action"": [
    ""ec2:Describe*""
  ],
  ""Effect"": ""Allow"",
  ""Resource"": ""*""
}
]
}

",
    });
}

}
Inheritance
System.Object
Resource
CustomResource
Policy
Inherited Members
CustomResource.Id
Resource.GetResourceType()
Resource.GetResourceName()
Resource.Urn
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Aws.Iam
Assembly: Pulumi.Aws.dll
Syntax
public class Policy : CustomResource

Constructors

View Source

Policy(String, PolicyArgs, CustomResourceOptions)

Create a Policy resource with the given unique name, arguments, and options.

Declaration
public Policy(string name, PolicyArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource

PolicyArgs args

The arguments used to populate this resource's properties

CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

Arn

The ARN assigned by AWS to this policy.

Declaration
public Output<string> Arn { get; }
Property Value
Type Description
Output<System.String>
View Source

Description

Description of the IAM policy.

Declaration
public Output<string> Description { get; }
Property Value
Type Description
Output<System.String>
View Source

Name

The name of the policy. If omitted, this provider will assign a random, unique name.

Declaration
public Output<string> Name { get; }
Property Value
Type Description
Output<System.String>
View Source

NamePrefix

Creates a unique name beginning with the specified prefix. Conflicts with name.

Declaration
public Output<string> NamePrefix { get; }
Property Value
Type Description
Output<System.String>
View Source

Path

Path in which to create the policy. See IAM Identifiers for more information.

Declaration
public Output<string> Path { get; }
Property Value
Type Description
Output<System.String>
View Source

PolicyDocument

The policy document. This is a JSON formatted string.

Declaration
public Output<string> PolicyDocument { get; }
Property Value
Type Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, PolicyState, CustomResourceOptions)

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

Declaration
public static Policy Get(string name, Input<string> id, PolicyState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.

Input<System.String> id

The unique provider ID of the resource to lookup.

PolicyState state

Any extra arguments used during the lookup.

CustomResourceOptions options

A bag of options that control this resource's behavior

Returns
Type Description
Policy
  • View Source
Back to top Copyright 2016-2020, Pulumi Corporation.