AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreatePolicy operation. Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual Amazon Web Services account.

For more information about policies and their use, see Managing Organizations policies.

If the request includes tags, then the requester must have the organizations:TagResource permission.

This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Organizations.AmazonOrganizationsRequest
      Amazon.Organizations.Model.CreatePolicyRequest

Namespace: Amazon.Organizations.Model
Assembly: AWSSDK.Organizations.dll
Version: 3.x.y.z

Syntax

C#
public class CreatePolicyRequest : AmazonOrganizationsRequest
         IAmazonWebServiceRequest

The CreatePolicyRequest type exposes the following members

Constructors

NameDescription
Public Method CreatePolicyRequest()

Properties

NameTypeDescription
Public Property Content System.String

Gets and sets the property Content.

The policy text content to add to the new policy. The text that you supply must adhere to the rules of the policy type you specify in the Type parameter.

The maximum size of a policy document depends on the policy's type. For more information, see Maximum and minimum values in the Organizations User Guide.

Public Property Description System.String

Gets and sets the property Description.

An optional description to assign to the policy.

Public Property Name System.String

Gets and sets the property Name.

The friendly name to assign to the policy.

The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

Public Property Tags System.Collections.Generic.List<Amazon.Organizations.Model.Tag>

Gets and sets the property Tags.

A list of tags that you want to attach to the newly created policy. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null. For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.

If any one of the tags is not valid or if you exceed the allowed number of tags for a policy, then the entire request fails and the policy is not created.

Public Property Type Amazon.Organizations.PolicyType

Gets and sets the property Type.

The type of policy to create. You can specify one of the following values:

Examples

The following example shows how to create a service control policy (SCP) that is named AllowAllS3Actions. The JSON string in the content parameter specifies the content in the policy. The parameter string is escaped with backslashes to ensure that the embedded double quotes in the JSON policy are treated as literals in the parameter, which itself is surrounded by double quotes:

To create a service control policy


var client = new AmazonOrganizationsClient();
var response = client.CreatePolicy(new CreatePolicyRequest 
{
    Content = "{\\"Version\\":\\"2012-10-17\\",\\"Statement\\":{\\"Effect\\":\\"Allow\\",\\"Action\\":\\"s3:*\\"}}",
    Description = "Enables admins of attached accounts to delegate all S3 permissions",
    Name = "AllowAllS3Actions",
    Type = "SERVICE_CONTROL_POLICY"
});

Policy policy = response.Policy;

            

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5