Class: Aws::Organizations::Types::AttachPolicyRequest

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

Overview

Note:

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

{
  policy_id: "PolicyId", # required
  target_id: "PolicyTargetId", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#policy_idString

The unique identifier (ID) of the policy that you want to attach to the target. You can get the ID for the policy by calling the ListPolicies operation.

The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

Returns:

  • (String)


293
294
295
296
297
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 293

class AttachPolicyRequest < Struct.new(
  :policy_id,
  :target_id)
  include Aws::Structure
end

#target_idString

The unique identifier (ID) of the root, OU, or account that you want to attach the policy to. You can get the ID by calling the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations.

The regex pattern for a target ID string requires one of the following:

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.

  • Account - A string that consists of exactly 12 digits.

  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

Returns:

  • (String)


293
294
295
296
297
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 293

class AttachPolicyRequest < Struct.new(
  :policy_id,
  :target_id)
  include Aws::Structure
end