Class: Aws::IAM::Types::SimulateCustomPolicyRequest

Inherits:

Struct

Object
Struct
Aws::IAM::Types::SimulateCustomPolicyRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-iam/types.rb

Overview

Note:

When making an API call, you may pass SimulateCustomPolicyRequest data as a hash:

{
  policy_input_list: ["policyDocumentType"], # required
  action_names: ["ActionNameType"], # required
  resource_arns: ["ResourceNameType"],
  resource_policy: "policyDocumentType",
  resource_owner: "ResourceNameType",
  caller_arn: "ResourceNameType",
  context_entries: [
    {
      context_key_name: "ContextKeyNameType",
      context_key_values: ["ContextKeyValueType"],
      context_key_type: "string", # accepts string, stringList, numeric, numericList, boolean, booleanList, ip, ipList, binary, binaryList, date, dateList
    },
  ],
  resource_handling_option: "ResourceHandlingOptionType",
  max_items: 1,
  marker: "markerType",
}

Instance Attribute Summary collapse

#action_names ⇒ Array<String>

A list of names of API operations to evaluate in the simulation.
#caller_arn ⇒ String

The ARN of the IAM user that you want to use as the simulated caller of the API operations.
#context_entries ⇒ Array<Types::ContextEntry>

A list of context keys and corresponding values for the simulation to use.
#marker ⇒ String

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.
#max_items ⇒ Integer

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response.
#policy_input_list ⇒ Array<String>

A list of policy documents to include in the simulation.
#resource_arns ⇒ Array<String>

A list of ARNs of AWS resources to include in the simulation.
#resource_handling_option ⇒ String

Specifies the type of simulation to run.
#resource_owner ⇒ String

An ARN representing the AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object.
#resource_policy ⇒ String

A resource-based policy to include in the simulation provided as a string.

Instance Attribute Details

#action_names ⇒ `Array<String>`

A list of names of API operations to evaluate in the simulation. Each operation is evaluated against each resource. Each operation must include the service identifier, such as ‘iam:CreateUser`.

Returns:

(Array<String>)

# File 'lib/aws-sdk-iam/types.rb', line 7906

class SimulateCustomPolicyRequest < Struct.new(
  :policy_input_list,
  :action_names,
  :resource_arns,
  :resource_policy,
  :resource_owner,
  :caller_arn,
  :context_entries,
  :resource_handling_option,
  :max_items,
  :marker)
  include Aws::Structure
end

#caller_arn ⇒ `String`

The ARN of the IAM user that you want to use as the simulated caller of the API operations. ‘CallerArn` is required if you include a `ResourcePolicy` so that the policy’s ‘Principal` element has a value to use in evaluating the policy.

You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.

Returns:

(String)

# File 'lib/aws-sdk-iam/types.rb', line 7906

class SimulateCustomPolicyRequest < Struct.new(
  :policy_input_list,
  :action_names,
  :resource_arns,
  :resource_policy,
  :resource_owner,
  :caller_arn,
  :context_entries,
  :resource_handling_option,
  :max_items,
  :marker)
  include Aws::Structure
end

#context_entries ⇒ `Array<Types::ContextEntry>`

A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permission policies, the corresponding value is supplied.

Returns:

(Array<Types::ContextEntry>)

# File 'lib/aws-sdk-iam/types.rb', line 7906

class SimulateCustomPolicyRequest < Struct.new(
  :policy_input_list,
  :action_names,
  :resource_arns,
  :resource_policy,
  :resource_owner,
  :caller_arn,
  :context_entries,
  :resource_handling_option,
  :max_items,
  :marker)
  include Aws::Structure
end

#marker ⇒ `String`

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the ‘Marker` element in the response that you received to indicate where the next call should start.

Returns:

(String)

# File 'lib/aws-sdk-iam/types.rb', line 7906

class SimulateCustomPolicyRequest < Struct.new(
  :policy_input_list,
  :action_names,
  :resource_arns,
  :resource_policy,
  :resource_owner,
  :caller_arn,
  :context_entries,
  :resource_handling_option,
  :max_items,
  :marker)
  include Aws::Structure
end

#max_items ⇒ `Integer`

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the ‘IsTruncated` response element is `true`.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the ‘IsTruncated` response element returns `true` and `Marker` contains a value to include in the subsequent call that tells the service where to continue from.

Returns:

(Integer)

# File 'lib/aws-sdk-iam/types.rb', line 7906

class SimulateCustomPolicyRequest < Struct.new(
  :policy_input_list,
  :action_names,
  :resource_arns,
  :resource_policy,
  :resource_owner,
  :caller_arn,
  :context_entries,
  :resource_handling_option,
  :max_items,
  :marker)
  include Aws::Structure
end

#policy_input_list ⇒ `Array<String>`

A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the ‘ResourcePolicy` parameter. The policies cannot be “scope-down” policies, such as you could include in a call to

GetFederationToken][1: or one of the [AssumeRole] API

operations. In other words, do not use policies designed to restrict what a user can do while using the temporary credentials.

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/APIReference/API_GetFederationToken.html [2]: docs.aws.amazon.com/IAM/latest/APIReference/API_AssumeRole.html [3]: wikipedia.org/wiki/regex

Returns:

(Array<String>)

# File 'lib/aws-sdk-iam/types.rb', line 7906

class SimulateCustomPolicyRequest < Struct.new(
  :policy_input_list,
  :action_names,
  :resource_arns,
  :resource_policy,
  :resource_owner,
  :caller_arn,
  :context_entries,
  :resource_handling_option,
  :max_items,
  :marker)
  include Aws::Structure
end

#resource_arns ⇒ `Array<String>`

A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided then the value defaults to ‘*` (all resources). Each API in the `ActionNames` parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response.

The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ‘ResourcePolicy` parameter.

If you include a ‘ResourcePolicy`, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error.

For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces] in the *AWS General Reference*.

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

Returns:

(Array<String>)

# File 'lib/aws-sdk-iam/types.rb', line 7906

class SimulateCustomPolicyRequest < Struct.new(
  :policy_input_list,
  :action_names,
  :resource_arns,
  :resource_policy,
  :resource_owner,
  :caller_arn,
  :context_entries,
  :resource_handling_option,
  :max_items,
  :marker)
  include Aws::Structure
end

#resource_handling_option ⇒ `String`

Specifies the type of simulation to run. Different API operations that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.

Each of the EC2 scenarios requires that you specify instance, image, and security-group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network-interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see [Supported Platforms] in the *Amazon EC2 User Guide*.

EC2-Classic-InstanceStore

instance, image, security-group
EC2-Classic-EBS

instance, image, security-group, volume
EC2-VPC-InstanceStore

instance, image, security-group, network-interface
EC2-VPC-InstanceStore-Subnet

instance, image, security-group, network-interface, subnet
EC2-VPC-EBS

instance, image, security-group, network-interface, volume
EC2-VPC-EBS-Subnet

instance, image, security-group, network-interface, subnet, volume

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html

Returns:

(String)

# File 'lib/aws-sdk-iam/types.rb', line 7906

class SimulateCustomPolicyRequest < Struct.new(
  :policy_input_list,
  :action_names,
  :resource_arns,
  :resource_policy,
  :resource_owner,
  :caller_arn,
  :context_entries,
  :resource_handling_option,
  :max_items,
  :marker)
  include Aws::Structure
end

#resource_owner ⇒ `String`

An ARN representing the AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object. If ‘ResourceOwner` is specified, it is also used as the account owner of any `ResourcePolicy` included in the simulation. If the `ResourceOwner` parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in `CallerArn`. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user `CallerArn`.

The ARN for an account uses the following syntax: ‘arn:aws:iam::AWS-account-ID:root`. For example, to represent the account with the 112233445566 ID, use the following ARN: `arn:aws:iam::112233445566-ID:root`.

Returns:

(String)

# File 'lib/aws-sdk-iam/types.rb', line 7906

class SimulateCustomPolicyRequest < Struct.new(
  :policy_input_list,
  :action_names,
  :resource_arns,
  :resource_policy,
  :resource_owner,
  :caller_arn,
  :context_entries,
  :resource_handling_option,
  :max_items,
  :marker)
  include Aws::Structure
end

#resource_policy ⇒ `String`

A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.

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]: wikipedia.org/wiki/regex

Returns:

(String)

# File 'lib/aws-sdk-iam/types.rb', line 7906

class SimulateCustomPolicyRequest < Struct.new(
  :policy_input_list,
  :action_names,
  :resource_arns,
  :resource_policy,
  :resource_owner,
  :caller_arn,
  :context_entries,
  :resource_handling_option,
  :max_items,
  :marker)
  include Aws::Structure
end

Class: Aws::IAM::Types::SimulateCustomPolicyRequest

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#action_names ⇒ Array<String>

#caller_arn ⇒ String

#context_entries ⇒ Array<Types::ContextEntry>

#marker ⇒ String

#max_items ⇒ Integer

#policy_input_list ⇒ Array<String>

#resource_arns ⇒ Array<String>

#resource_handling_option ⇒ String

#resource_owner ⇒ String

#resource_policy ⇒ String

#action_names ⇒ `Array<String>`

#caller_arn ⇒ `String`

#context_entries ⇒ `Array<Types::ContextEntry>`

#marker ⇒ `String`

#max_items ⇒ `Integer`

#policy_input_list ⇒ `Array<String>`

#resource_arns ⇒ `Array<String>`

#resource_handling_option ⇒ `String`

#resource_owner ⇒ `String`

#resource_policy ⇒ `String`