You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Organizations::Types::PolicyTargetSummary

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

Overview

Contains information about a root, OU, or account that a policy is attached to.

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the policy target.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

Returns:

  • (String)


2685
2686
2687
2688
2689
2690
2691
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2685

class PolicyTargetSummary < Struct.new(
  :target_id,
  :arn,
  :name,
  :type)
  include Aws::Structure
end

#nameString

The friendly name of the policy target.

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

Returns:

  • (String)


2685
2686
2687
2688
2689
2690
2691
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2685

class PolicyTargetSummary < Struct.new(
  :target_id,
  :arn,
  :name,
  :type)
  include Aws::Structure
end

#target_idString

The unique identifier (ID) of the policy target.

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 lower-case 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 lower-case letters or digits (the ID of the root that the OU is in) followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.

Returns:

  • (String)


2685
2686
2687
2688
2689
2690
2691
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2685

class PolicyTargetSummary < Struct.new(
  :target_id,
  :arn,
  :name,
  :type)
  include Aws::Structure
end

#typeString

The type of the policy target.

Returns:

  • (String)


2685
2686
2687
2688
2689
2690
2691
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 2685

class PolicyTargetSummary < Struct.new(
  :target_id,
  :arn,
  :name,
  :type)
  include Aws::Structure
end