Class: Aws::Organizations::Types::CreatePolicyRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-organizations/types.rb

Overview

Note:

When making an API call, you may pass CreatePolicyRequest data as a hash:

{
  content: "PolicyContent", # required
  description: "PolicyDescription", # required
  name: "PolicyName", # required
  type: "SERVICE_CONTROL_POLICY", # required, accepts SERVICE_CONTROL_POLICY
}

Instance Attribute Summary collapse

Instance Attribute Details

#contentString

The policy content to add to the new policy. For example, if you create a [service control policy] (SCP), this string must be JSON text that specifies the permissions that admins in attached accounts can delegate to their users, groups, and roles. For more information about the SCP syntax, see [Service Control Policy Syntax] in the *AWS Organizations User Guide*.

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html [2]: docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_scp-syntax.html

Returns:

  • (String)


574
575
576
577
578
579
580
# File 'lib/aws-sdk-organizations/types.rb', line 574

class CreatePolicyRequest < Struct.new(
  :content,
  :description,
  :name,
  :type)
  include Aws::Structure
end

#descriptionString

An optional description to assign to the policy.

Returns:

  • (String)


574
575
576
577
578
579
580
# File 'lib/aws-sdk-organizations/types.rb', line 574

class CreatePolicyRequest < Struct.new(
  :content,
  :description,
  :name,
  :type)
  include Aws::Structure
end

#nameString

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.

[1]: wikipedia.org/wiki/regex

Returns:

  • (String)


574
575
576
577
578
579
580
# File 'lib/aws-sdk-organizations/types.rb', line 574

class CreatePolicyRequest < Struct.new(
  :content,
  :description,
  :name,
  :type)
  include Aws::Structure
end

#typeString

The type of policy to create.

<note markdown=“1”> In the current release, the only type of policy that you can create is a service control policy (SCP).

</note>

Returns:

  • (String)


574
575
576
577
578
579
580
# File 'lib/aws-sdk-organizations/types.rb', line 574

class CreatePolicyRequest < Struct.new(
  :content,
  :description,
  :name,
  :type)
  include Aws::Structure
end