Class: Aws::IAM::Types::Policy

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

Overview

Contains information about a managed policy.

This data type is used as a response element in the CreatePolicy, GetPolicy, and ListPolicies operations.

For more information about managed policies, refer to [Managed policies and inline policies] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.

For more information about ARNs, go to [Amazon Resource Names (ARNs)] in the *Amazon Web Services General Reference*.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (String)

8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
# File 'lib/aws-sdk-iam/types.rb', line 8640

class Policy < Struct.new(
  :policy_name,
  :policy_id,
  :arn,
  :path,
  :default_version_id,
  :attachment_count,
  :permissions_boundary_usage_count,
  :is_attachable,
  :description,
  :create_date,
  :update_date,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#attachment_countInteger

The number of entities (users, groups, and roles) that the policy is attached to.

Returns:

  • (Integer)

8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
# File 'lib/aws-sdk-iam/types.rb', line 8640

class Policy < Struct.new(
  :policy_name,
  :policy_id,
  :arn,
  :path,
  :default_version_id,
  :attachment_count,
  :permissions_boundary_usage_count,
  :is_attachable,
  :description,
  :create_date,
  :update_date,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#create_dateTime

The date and time, in [ISO 8601 date-time format], when the policy was created.

[1]: www.iso.org/iso/iso8601

Returns:

  • (Time)

8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
# File 'lib/aws-sdk-iam/types.rb', line 8640

class Policy < Struct.new(
  :policy_name,
  :policy_id,
  :arn,
  :path,
  :default_version_id,
  :attachment_count,
  :permissions_boundary_usage_count,
  :is_attachable,
  :description,
  :create_date,
  :update_date,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#default_version_idString

The identifier for the version of the policy that is set as the default version.

Returns:

  • (String)

8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
# File 'lib/aws-sdk-iam/types.rb', line 8640

class Policy < Struct.new(
  :policy_name,
  :policy_id,
  :arn,
  :path,
  :default_version_id,
  :attachment_count,
  :permissions_boundary_usage_count,
  :is_attachable,
  :description,
  :create_date,
  :update_date,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A friendly description of the policy.

This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.

Returns:

  • (String)

8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
# File 'lib/aws-sdk-iam/types.rb', line 8640

class Policy < Struct.new(
  :policy_name,
  :policy_id,
  :arn,
  :path,
  :default_version_id,
  :attachment_count,
  :permissions_boundary_usage_count,
  :is_attachable,
  :description,
  :create_date,
  :update_date,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#is_attachableBoolean

Specifies whether the policy can be attached to an IAM user, group, or role.

Returns:

  • (Boolean)

8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
# File 'lib/aws-sdk-iam/types.rb', line 8640

class Policy < Struct.new(
  :policy_name,
  :policy_id,
  :arn,
  :path,
  :default_version_id,
  :attachment_count,
  :permissions_boundary_usage_count,
  :is_attachable,
  :description,
  :create_date,
  :update_date,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#pathString

The path to the policy.

For more information about paths, see [IAM identifiers] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html

Returns:

  • (String)

8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
# File 'lib/aws-sdk-iam/types.rb', line 8640

class Policy < Struct.new(
  :policy_name,
  :policy_id,
  :arn,
  :path,
  :default_version_id,
  :attachment_count,
  :permissions_boundary_usage_count,
  :is_attachable,
  :description,
  :create_date,
  :update_date,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#permissions_boundary_usage_countInteger

The number of entities (users and roles) for which the policy is used to set the permissions boundary.

For more information about permissions boundaries, see [Permissions boundaries for IAM identities ][1] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html

Returns:

  • (Integer)

8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
# File 'lib/aws-sdk-iam/types.rb', line 8640

class Policy < Struct.new(
  :policy_name,
  :policy_id,
  :arn,
  :path,
  :default_version_id,
  :attachment_count,
  :permissions_boundary_usage_count,
  :is_attachable,
  :description,
  :create_date,
  :update_date,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#policy_idString

The stable and unique string identifying the policy.

For more information about IDs, see [IAM identifiers] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html

Returns:

  • (String)

8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
# File 'lib/aws-sdk-iam/types.rb', line 8640

class Policy < Struct.new(
  :policy_name,
  :policy_id,
  :arn,
  :path,
  :default_version_id,
  :attachment_count,
  :permissions_boundary_usage_count,
  :is_attachable,
  :description,
  :create_date,
  :update_date,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#policy_nameString

The friendly name (not ARN) identifying the policy.

Returns:

  • (String)

8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
# File 'lib/aws-sdk-iam/types.rb', line 8640

class Policy < Struct.new(
  :policy_name,
  :policy_id,
  :arn,
  :path,
  :default_version_id,
  :attachment_count,
  :permissions_boundary_usage_count,
  :is_attachable,
  :description,
  :create_date,
  :update_date,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of tags that are attached to the instance profile. For more information about tagging, see [Tagging IAM resources] in the *IAM User Guide*.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Returns:


8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
# File 'lib/aws-sdk-iam/types.rb', line 8640

class Policy < Struct.new(
  :policy_name,
  :policy_id,
  :arn,
  :path,
  :default_version_id,
  :attachment_count,
  :permissions_boundary_usage_count,
  :is_attachable,
  :description,
  :create_date,
  :update_date,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#update_dateTime

The date and time, in [ISO 8601 date-time format], when the policy was last updated.

When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.

[1]: www.iso.org/iso/iso8601

Returns:

  • (Time)

8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
# File 'lib/aws-sdk-iam/types.rb', line 8640

class Policy < Struct.new(
  :policy_name,
  :policy_id,
  :arn,
  :path,
  :default_version_id,
  :attachment_count,
  :permissions_boundary_usage_count,
  :is_attachable,
  :description,
  :create_date,
  :update_date,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end