Class: Aws::IAM::Policy

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
lib/aws-sdk-iam/policy.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(arn, options = {}) ⇒ Policy #initialize(options = {}) ⇒ Policy

Returns a new instance of Policy.

Overloads:

  • #initialize(arn, options = {}) ⇒ Policy

    Parameters:

    • arn (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Policy

    Options Hash (options):

    • :arn (required, String)
    • :client (Client)

22
23
24
25
26
27
28
# File 'lib/aws-sdk-iam/policy.rb', line 22

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @arn = extract_arn(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#arnString

Returns:

  • (String)

33
34
35
# File 'lib/aws-sdk-iam/policy.rb', line 33

def arn
  @arn
end

#attach_group(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


policy.attach_group({
  group_name: "groupNameType", # required
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :group_name (required, String)

    The name (friendly name, not ARN) of the group to attach the policy to.

    This parameter allows (through its [regex pattern]) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,[email protected]

    [1]: wikipedia.org/wiki/regex

Returns:

  • (EmptyStructure)

305
306
307
308
309
# File 'lib/aws-sdk-iam/policy.rb', line 305

def attach_group(options = {})
  options = options.merge(policy_arn: @arn)
  resp = @client.attach_group_policy(options)
  resp.data
end

#attach_role(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


policy.attach_role({
  role_name: "roleNameType", # required
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :role_name (required, String)

    The name (friendly name, not ARN) of the role to attach the policy to.

    This parameter allows (through its [regex pattern]) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,[email protected]

    [1]: wikipedia.org/wiki/regex

Returns:

  • (EmptyStructure)

329
330
331
332
333
# File 'lib/aws-sdk-iam/policy.rb', line 329

def attach_role(options = {})
  options = options.merge(policy_arn: @arn)
  resp = @client.attach_role_policy(options)
  resp.data
end

#attach_user(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


policy.attach_user({
  user_name: "userNameType", # required
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :user_name (required, String)

    The name (friendly name, not ARN) of the IAM user to attach the policy to.

    This parameter allows (through its [regex pattern]) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,[email protected]

    [1]: wikipedia.org/wiki/regex

Returns:

  • (EmptyStructure)

354
355
356
357
358
# File 'lib/aws-sdk-iam/policy.rb', line 354

def attach_user(options = {})
  options = options.merge(policy_arn: @arn)
  resp = @client.attach_user_policy(options)
  resp.data
end

#attached_groups(options = {}) ⇒ Group::Collection

Examples:

Request syntax with placeholder values


attached_groups = policy.attached_groups({
  path_prefix: "pathType",
  policy_usage_filter: "PermissionsPolicy", # accepts PermissionsPolicy, PermissionsBoundary
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :path_prefix (String)

    The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.

    This parameter allows (through its [regex pattern]) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (`u0021`) through the DEL character (`u007F`), including most punctuation characters, digits, and upper and lowercased letters.

    [1]: wikipedia.org/wiki/regex

  • :policy_usage_filter (String)

    The policy usage method to use for filtering the results.

    To list only permissions policies, set `PolicyUsageFilter` to `PermissionsPolicy`. To list only the policies used to set permissions boundaries, set the value to `PermissionsBoundary`.

    This parameter is optional. If it is not included, all policies are returned.

Returns:


543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
# File 'lib/aws-sdk-iam/policy.rb', line 543

def attached_groups(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(
      policy_arn: @arn,
      entity_filter: "Group"
    )
    resp = @client.list_entities_for_policy(options)
    resp.each_page do |page|
      batch = []
      page.data.policy_groups.each do |p|
        batch << Group.new(
          name: p.group_name,
          data: p,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Group::Collection.new(batches)
end

#attached_roles(options = {}) ⇒ Role::Collection

Examples:

Request syntax with placeholder values


attached_roles = policy.attached_roles({
  path_prefix: "pathType",
  policy_usage_filter: "PermissionsPolicy", # accepts PermissionsPolicy, PermissionsBoundary
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :path_prefix (String)

    The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.

    This parameter allows (through its [regex pattern]) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (`u0021`) through the DEL character (`u007F`), including most punctuation characters, digits, and upper and lowercased letters.

    [1]: wikipedia.org/wiki/regex

  • :policy_usage_filter (String)

    The policy usage method to use for filtering the results.

    To list only permissions policies, set `PolicyUsageFilter` to `PermissionsPolicy`. To list only the policies used to set permissions boundaries, set the value to `PermissionsBoundary`.

    This parameter is optional. If it is not included, all policies are returned.

Returns:


598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
# File 'lib/aws-sdk-iam/policy.rb', line 598

def attached_roles(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(
      policy_arn: @arn,
      entity_filter: "Role"
    )
    resp = @client.list_entities_for_policy(options)
    resp.each_page do |page|
      batch = []
      page.data.policy_roles.each do |p|
        batch << Role.new(
          name: p.role_name,
          data: p,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Role::Collection.new(batches)
end

#attached_users(options = {}) ⇒ User::Collection

Examples:

Request syntax with placeholder values


attached_users = policy.attached_users({
  path_prefix: "pathType",
  policy_usage_filter: "PermissionsPolicy", # accepts PermissionsPolicy, PermissionsBoundary
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :path_prefix (String)

    The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.

    This parameter allows (through its [regex pattern]) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (`u0021`) through the DEL character (`u007F`), including most punctuation characters, digits, and upper and lowercased letters.

    [1]: wikipedia.org/wiki/regex

  • :policy_usage_filter (String)

    The policy usage method to use for filtering the results.

    To list only permissions policies, set `PolicyUsageFilter` to `PermissionsPolicy`. To list only the policies used to set permissions boundaries, set the value to `PermissionsBoundary`.

    This parameter is optional. If it is not included, all policies are returned.

Returns:


653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
# File 'lib/aws-sdk-iam/policy.rb', line 653

def attached_users(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(
      policy_arn: @arn,
      entity_filter: "User"
    )
    resp = @client.list_entities_for_policy(options)
    resp.each_page do |page|
      batch = []
      page.data.policy_users.each do |p|
        batch << User.new(
          name: p.user_name,
          data: p,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  User::Collection.new(batches)
end

#attachment_countInteger

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

Returns:

  • (Integer)

79
80
81
# File 'lib/aws-sdk-iam/policy.rb', line 79

def attachment_count
  data[:attachment_count]
end

#clientClient

Returns:


155
156
157
# File 'lib/aws-sdk-iam/policy.rb', line 155

def client
  @client
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)

120
121
122
# File 'lib/aws-sdk-iam/policy.rb', line 120

def create_date
  data[:create_date]
end

#create_version(options = {}) ⇒ PolicyVersion

Examples:

Request syntax with placeholder values


policyversion = policy.create_version({
  policy_document: "policyDocumentType", # required
  set_as_default: false,
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :policy_document (required, String)

    The JSON policy document that you want to use as the content for this new version of the policy.

    You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

    The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see [IAM and STS character quotas].

    The [regex pattern] used to validate this parameter is a string of characters consisting of the following:

    • Any printable ASCII character ranging from the space character (`u0020`) through the end of the ASCII character range

    • The printable characters in the Basic Latin and Latin-1 Supplement character set (through `u00FF`)

    • The special characters tab (`u0009`), line feed (`u000A`), and carriage return (`u000D`)

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length [2]: wikipedia.org/wiki/regex

  • :set_as_default (Boolean)

    Specifies whether to set this version as the policy's default version.

    When this parameter is `true`, the new policy version becomes the operative version. That is, it becomes the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

    For more information about managed policy versions, see [Versioning for managed policies] in the *IAM User Guide*.

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

Returns:


412
413
414
415
416
417
418
419
420
# File 'lib/aws-sdk-iam/policy.rb', line 412

def create_version(options = {})
  options = options.merge(policy_arn: @arn)
  resp = @client.create_policy_version(options)
  PolicyVersion.new(
    arn: @arn,
    version_id: resp.data.policy_version.version_id,
    client: @client
  )
end

#dataTypes::Policy

Returns the data for this Aws::IAM::Policy. Calls Client#get_policy if #data_loaded? is `false`.

Returns:


175
176
177
178
# File 'lib/aws-sdk-iam/policy.rb', line 175

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns `true` if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns `true` if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.


183
184
185
# File 'lib/aws-sdk-iam/policy.rb', line 183

def data_loaded?
  !!@data
end

#default_versionPolicyVersion?

Returns:


676
677
678
679
680
681
682
683
684
685
686
# File 'lib/aws-sdk-iam/policy.rb', line 676

def default_version
  if data[:default_version_id]
    PolicyVersion.new(
      arn: @arn,
      version_id: data[:default_version_id],
      client: @client
    )
  else
    nil
  end
end

#default_version_idString

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

Returns:

  • (String)

72
73
74
# File 'lib/aws-sdk-iam/policy.rb', line 72

def default_version_id
  data[:default_version_id]
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


policy.delete()

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Returns:

  • (EmptyStructure)

427
428
429
430
431
# File 'lib/aws-sdk-iam/policy.rb', line 427

def delete(options = {})
  options = options.merge(policy_arn: @arn)
  resp = @client.delete_policy(options)
  resp.data
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)

109
110
111
# File 'lib/aws-sdk-iam/policy.rb', line 109

def description
  data[:description]
end

#detach_group(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


policy.detach_group({
  group_name: "groupNameType", # required
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :group_name (required, String)

    The name (friendly name, not ARN) of the IAM group to detach the policy from.

    This parameter allows (through its [regex pattern]) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,[email protected]

    [1]: wikipedia.org/wiki/regex

Returns:

  • (EmptyStructure)

452
453
454
455
456
# File 'lib/aws-sdk-iam/policy.rb', line 452

def detach_group(options = {})
  options = options.merge(policy_arn: @arn)
  resp = @client.detach_group_policy(options)
  resp.data
end

#detach_role(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


policy.detach_role({
  role_name: "roleNameType", # required
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :role_name (required, String)

    The name (friendly name, not ARN) of the IAM role to detach the policy from.

    This parameter allows (through its [regex pattern]) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,[email protected]

    [1]: wikipedia.org/wiki/regex

Returns:

  • (EmptyStructure)

477
478
479
480
481
# File 'lib/aws-sdk-iam/policy.rb', line 477

def detach_role(options = {})
  options = options.merge(policy_arn: @arn)
  resp = @client.detach_role_policy(options)
  resp.data
end

#detach_user(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


policy.detach_user({
  user_name: "userNameType", # required
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :user_name (required, String)

    The name (friendly name, not ARN) of the IAM user to detach the policy from.

    This parameter allows (through its [regex pattern]) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,[email protected]

    [1]: wikipedia.org/wiki/regex

Returns:

  • (EmptyStructure)

502
503
504
505
506
# File 'lib/aws-sdk-iam/policy.rb', line 502

def detach_user(options = {})
  options = options.merge(policy_arn: @arn)
  resp = @client.detach_user_policy(options)
  resp.data
end

#identifiersObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.

715
716
717
# File 'lib/aws-sdk-iam/policy.rb', line 715

def identifiers
  { arn: @arn }
end

#is_attachableBoolean

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

Returns:

  • (Boolean)

100
101
102
# File 'lib/aws-sdk-iam/policy.rb', line 100

def is_attachable
  data[:is_attachable]
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::IAM::Policy. Returns `self` making it possible to chain methods.

policy.reload.data

Returns:

  • (self)

165
166
167
168
169
# File 'lib/aws-sdk-iam/policy.rb', line 165

def load
  resp = @client.get_policy(policy_arn: @arn)
  @data = resp.policy
  self
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)

65
66
67
# File 'lib/aws-sdk-iam/policy.rb', line 65

def path
  data[:path]
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)

93
94
95
# File 'lib/aws-sdk-iam/policy.rb', line 93

def permissions_boundary_usage_count
  data[:permissions_boundary_usage_count]
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)

52
53
54
# File 'lib/aws-sdk-iam/policy.rb', line 52

def policy_id
  data[:policy_id]
end

#policy_nameString

The friendly name (not ARN) identifying the policy.

Returns:

  • (String)

39
40
41
# File 'lib/aws-sdk-iam/policy.rb', line 39

def policy_name
  data[:policy_name]
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:


148
149
150
# File 'lib/aws-sdk-iam/policy.rb', line 148

def tags
  data[:tags]
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)

136
137
138
# File 'lib/aws-sdk-iam/policy.rb', line 136

def update_date
  data[:update_date]
end

#versions(options = {}) ⇒ PolicyVersion::Collection

Examples:

Request syntax with placeholder values


policy.versions()

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Returns:


693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
# File 'lib/aws-sdk-iam/policy.rb', line 693

def versions(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(policy_arn: @arn)
    resp = @client.list_policy_versions(options)
    resp.each_page do |page|
      batch = []
      page.data.versions.each do |v|
        batch << PolicyVersion.new(
          arn: @arn,
          version_id: v.version_id,
          data: v,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  PolicyVersion::Collection.new(batches)
end

#wait_until(options = {}) {|resource| ... } ⇒ Resource

Deprecated.

Use [Aws::IAM::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged.

Waiter polls an API operation until a resource enters a desired state.

## Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

## Example

instance.wait_until(max_attempts:10, delay:5) do |instance|
  instance.state.name == 'running'
end

## Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

## Callbacks

You can be notified before each polling attempt and before each delay. If you throw `:success` or `:failure` from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

## Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10

    Maximum number of

  • :delay (Integer) — default: 10

    Delay between each

  • :before_attempt (Proc) — default: nil

    Callback

  • :before_wait (Proc) — default: nil

    Callback

Yield Parameters:

  • resource (Resource)

    to be used in the waiting condition.

Returns:

  • (Resource)

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError)

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError)

    Raised when the resource does not


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
# File 'lib/aws-sdk-iam/policy.rb', line 267

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end