Class: Aws::IAM::Policy

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

Overview

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IAM/Policy.html

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) 


13
14
15
 
# File 'sig/policy.rbs', line 13

def initialize: (String arn, Hash[Symbol, untyped] options) -> void
| (arn: String, ?client: Client) -> void
| (Hash[Symbol, untyped] args) -> void

Instance Method Details

#arn ⇒ String

Returns:

  • (String) 


18
 
# File 'sig/policy.rbs', line 18

def arn: () -> String

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

Returns:

  • (EmptyStructure) 


67
 
# File 'sig/policy.rbs', line 67

def attach_group: (

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

Returns:

  • (EmptyStructure) 


73
 
# File 'sig/policy.rbs', line 73

def attach_role: (

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

Returns:

  • (EmptyStructure) 


79
 
# File 'sig/policy.rbs', line 79

def attach_user: (

#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.

  • :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:



115
 
# File 'sig/policy.rbs', line 115

def attached_groups: (

#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.

  • :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:



122
 
# File 'sig/policy.rbs', line 122

def attached_roles: (

#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.

  • :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:



129
 
# File 'sig/policy.rbs', line 129

def attached_users: (

#attachment_count ⇒ Integer

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

Returns:

  • (Integer) 


33
 
# File 'sig/policy.rbs', line 33

def attachment_count: () -> ::Integer

#client ⇒ Client

Returns:



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

def client: () -> Client

#create_date ⇒ Time

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

Returns:

  • (Time) 


45
 
# File 'sig/policy.rbs', line 45

def create_date: () -> ::Time

#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)

  • :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.

Returns:



85
 
# File 'sig/policy.rbs', line 85

def create_version: (

#data ⇒ Types::Policy

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

Returns:



60
 
# File 'sig/policy.rbs', line 60

def data: () -> Types::Policy

#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.



63
 
# File 'sig/policy.rbs', line 63

def data_loaded?: () -> bool

#default_version ⇒ PolicyVersion?

Returns:



136
 
# File 'sig/policy.rbs', line 136

def default_version: () -> PolicyVersion?

#default_version_id ⇒ String

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

Returns:

  • (String) 


30
 
# File 'sig/policy.rbs', line 30

def default_version_id: () -> ::String

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


policy.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure) 


92
 
# File 'sig/policy.rbs', line 92

def delete: (

#description ⇒ String

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) 


42
 
# File 'sig/policy.rbs', line 42

def description: () -> ::String

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

Returns:

  • (EmptyStructure) 


97
 
# File 'sig/policy.rbs', line 97

def detach_group: (

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

Returns:

  • (EmptyStructure) 


103
 
# File 'sig/policy.rbs', line 103

def detach_role: (

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

Returns:

  • (EmptyStructure) 


109
 
# File 'sig/policy.rbs', line 109

def detach_user: (

#identifiers ⇒ Object

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. 


746
747
748
 
# File 'lib/aws-sdk-iam/policy.rb', line 746

def identifiers
  { arn: @arn }
end

#is_attachable ⇒ Boolean

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

Returns:

  • (Boolean) 


39
 
# File 'sig/policy.rbs', line 39

def is_attachable: () -> bool

#load ⇒ self 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) 


56
 
# File 'sig/policy.rbs', line 56

def load: () -> self

#path ⇒ String

The path to the policy.

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

Returns:

  • (String) 


27
 
# File 'sig/policy.rbs', line 27

def path: () -> ::String

#permissions_boundary_usage_count ⇒ Integer

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 in the IAM User Guide.

Returns:

  • (Integer) 


36
 
# File 'sig/policy.rbs', line 36

def permissions_boundary_usage_count: () -> ::Integer

#policy_id ⇒ String

The stable and unique string identifying the policy.

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

Returns:

  • (String) 


24
 
# File 'sig/policy.rbs', line 24

def policy_id: () -> ::String

#policy_name ⇒ String

The friendly name (not ARN) identifying the policy.

Returns:

  • (String) 


21
 
# File 'sig/policy.rbs', line 21

def policy_name: () -> ::String

#tags ⇒ Array<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.

Returns:



51
 
# File 'sig/policy.rbs', line 51

def tags: () -> ::Array[Types::Tag]

#update_date ⇒ Time

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) 


48
 
# File 'sig/policy.rbs', line 48

def update_date: () -> ::Time

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

Examples:

Request syntax with placeholder values


policy.versions()

Parameters:

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

    ({})

Returns:



139
 
# File 'sig/policy.rbs', line 139

def versions: (

#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