An AWS access control policy is a object that acts as a container for one or more statements, which specify fine grained rules for allowing or denying various types of actions from being performed on your AWS resources.
By default, all requests to use your resource coming from anyone but you are denied. Access control polices can override that by allowing different types of access to your resources, or by explicitly denying different types of access.
Each statement in an AWS access control policy takes the form: "A has permission to do B to C where D applies".
- A is the prinicpal The AWS account that is making a request to access or modify one of your AWS resources.
- B is the action the way in which your AWS resource is being accessed or modified, such as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket.
- C is the resource your AWS entity that the principal wants to access, such as an Amazon SQS queue, or an object stored in Amazon S3.
- D is the set of conditions optional constraints that specify when to allow or deny access for the principal to access your resource. Many expressive conditions are available, some specific to each service. For example you can use date conditions to allow access to your resources only after or before a specific time.
Note that an AWS access control policy should not be confused with the similarly named "POST form policy" concept used in Amazon S3.
In this article ▶
Inheritance Hierarchy
Namespace: Amazon.Auth.AccessControlPolicy
Assembly: AWSSDK.Core.dll
Version: 3.x.y.z
Syntax
public class Policy
The Policy type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
Policy() |
Constructs an empty AWS access control policy ready to be populated with statements. |
|
|
Policy(string) |
Constructs a new AWS access control policy with the specified policy ID. The policy ID is a user specified string that serves to help developers keep track of multiple polices. Policy IDs are often used as a human readable name for a policy. |
|
|
Policy(string, IList<Statement>) |
Constructs a new AWS access control policy with the specified policy ID and collection of statements. The policy ID is a user specified string that serves to help developers keep track of multiple polices. Policy IDs are often used as a human readable name for a policy. |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Id | System.String |
Gets and Sets the policy ID for this policy. Policy IDs serve to help developers keep track of multiple policies, and are often used as human readable name for a policy. |
|
|
Statements | System.Collections.Generic.IList<Amazon.Auth.AccessControlPolicy.Statement> |
Gets and Sets the collection of statements contained by this policy. Individual statements in a policy are what specify the rules that enable or disable access to your AWS resources. |
|
|
Version | System.String |
Gets and sets the version of this AWS policy. |
Methods
| Name | Description | |
|---|---|---|
|
|
CheckIfStatementExists(Statement) |
Checks to see if the permissions set in the statement are already set by another statement in the policy. |
|
|
FromJson(string) |
Parses a JSON document of a policy and creates a Policy object. |
|
|
ToJson() |
Returns a JSON string representation of this AWS access control policy, suitable to be sent to an AWS service as part of a request to set an access control policy. |
|
|
ToJson(bool) |
Returns a JSON string representation of this AWS access control policy, suitable to be sent to an AWS service as part of a request to set an access control policy. |
|
|
WithId(string) |
Sets the policy ID for this policy and returns the updated policy so that multiple calls can be chained together. Policy IDs serve to help developers keep track of multiple policies, and are often used as human readable name for a policy. |
|
|
WithStatements(Statement[]) |
Sets the collection of statements contained by this policy and returns this policy object so that additional method calls can be chained together. Individual statements in a policy are what specify the rules that enable or disable access to your AWS resources. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer