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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (EmptyStructure)


315
316
317
318
319
320
321
# File 'lib/aws-sdk-iam/policy.rb', line 315

def attach_group(options = {})
  options = options.merge(policy_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.attach_group_policy(options)
  end
  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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (EmptyStructure)


341
342
343
344
345
346
347
# File 'lib/aws-sdk-iam/policy.rb', line 341

def attach_role(options = {})
  options = options.merge(policy_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.attach_role_policy(options)
  end
  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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (EmptyStructure)


368
369
370
371
372
373
374
# File 'lib/aws-sdk-iam/policy.rb', line 368

def attach_user(options = {})
  options = options.merge(policy_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.attach_user_policy(options)
  end
  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:



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
# File 'lib/aws-sdk-iam/policy.rb', line 569

def attached_groups(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(
      policy_arn: @arn,
      entity_filter: "Group"
    )
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.list_entities_for_policy(options)
    end
    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:



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
# File 'lib/aws-sdk-iam/policy.rb', line 626

def attached_roles(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(
      policy_arn: @arn,
      entity_filter: "Role"
    )
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.list_entities_for_policy(options)
    end
    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:



683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
# File 'lib/aws-sdk-iam/policy.rb', line 683

def attached_users(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(
      policy_arn: @arn,
      entity_filter: "User"
    )
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.list_entities_for_policy(options)
    end
    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:



161
162
163
# File 'lib/aws-sdk-iam/policy.rb', line 161

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)


126
127
128
# File 'lib/aws-sdk-iam/policy.rb', line 126

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:



428
429
430
431
432
433
434
435
436
437
438
# File 'lib/aws-sdk-iam/policy.rb', line 428

def create_version(options = {})
  options = options.merge(policy_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.create_policy_version(options)
  end
  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:



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

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.



191
192
193
# File 'lib/aws-sdk-iam/policy.rb', line 191

def data_loaded?
  !!@data
end

#default_versionPolicyVersion?

Returns:



708
709
710
711
712
713
714
715
716
717
718
# File 'lib/aws-sdk-iam/policy.rb', line 708

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)


445
446
447
448
449
450
451
# File 'lib/aws-sdk-iam/policy.rb', line 445

def delete(options = {})
  options = options.merge(policy_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.delete_policy(options)
  end
  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.

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_GetPolicy.html [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_ListPolicies.html

Returns:

  • (String)


115
116
117
# File 'lib/aws-sdk-iam/policy.rb', line 115

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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (EmptyStructure)


472
473
474
475
476
477
478
# File 'lib/aws-sdk-iam/policy.rb', line 472

def detach_group(options = {})
  options = options.merge(policy_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.detach_group_policy(options)
  end
  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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (EmptyStructure)


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

def detach_role(options = {})
  options = options.merge(policy_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.detach_role_policy(options)
  end
  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: _+=,.@-

    [1]: wikipedia.org/wiki/regex

Returns:

  • (EmptyStructure)


526
527
528
529
530
531
532
# File 'lib/aws-sdk-iam/policy.rb', line 526

def detach_user(options = {})
  options = options.merge(policy_arn: @arn)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.detach_user_policy(options)
  end
  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.


749
750
751
# File 'lib/aws-sdk-iam/policy.rb', line 749

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)


171
172
173
174
175
176
177
# File 'lib/aws-sdk-iam/policy.rb', line 171

def load
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.get_policy(policy_arn: @arn)
  end
  @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:



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

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)


142
143
144
# File 'lib/aws-sdk-iam/policy.rb', line 142

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:



725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
# File 'lib/aws-sdk-iam/policy.rb', line 725

def versions(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(policy_arn: @arn)
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.list_policy_versions(options)
    end
    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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
# File 'lib/aws-sdk-iam/policy.rb', line 275

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::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end