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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iam/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 actions.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Returns:

  • (String)


6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 6034

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

#attachment_countInteger

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

Returns:

  • (Integer)


6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 6034

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

#create_dateTime

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

Returns:

  • (Time)


6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 6034

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

#default_version_idString

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

Returns:

  • (String)


6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 6034

class Policy < Struct.new(
  :policy_name,
  :policy_id,
  :arn,
  :path,
  :default_version_id,
  :attachment_count,
  :is_attachable,
  :description,
  :create_date,
  :update_date)
  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)


6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 6034

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

#is_attachableBoolean

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

Returns:

  • (Boolean)


6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 6034

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

#pathString

The path to the policy.

For more information about paths, see IAM Identifiers in the Using IAM guide.

Returns:

  • (String)


6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 6034

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

#policy_idString

The stable and unique string identifying the policy.

For more information about IDs, see IAM Identifiers in the Using IAM guide.

Returns:

  • (String)


6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 6034

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

#policy_nameString

The friendly name (not ARN) identifying the policy.

Returns:

  • (String)


6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 6034

class Policy < Struct.new(
  :policy_name,
  :policy_id,
  :arn,
  :path,
  :default_version_id,
  :attachment_count,
  :is_attachable,
  :description,
  :create_date,
  :update_date)
  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.

Returns:

  • (Time)


6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 6034

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