/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.identitymanagement.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class SimulatePrincipalPolicyRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation. If * you specify a user, group, or role, the simulation includes all policies that are associated with that entity. If * you specify a user, the simulation also includes all policies that are attached to any groups the user belongs * to. *

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

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. *

*/ private String policySourceArn; /** *

* An optional list of additional policy documents to include in the simulation. Each document is specified as a * string containing the complete, valid JSON text of an IAM policy. *

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

*/ private com.amazonaws.internal.SdkInternalList policyInputList; /** *

* The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that the * entity can have. You can input only one permissions boundary when you pass a policy to this operation. An IAM * entity can only have one permissions boundary in effect at a time. For example, if a permissions boundary is * attached to an entity and you pass in a different permissions boundary policy using this parameter, then the new * permissions boundary policy is used for the simulation. For more information about permissions boundaries, see Permissions boundaries * for IAM entities in the IAM User Guide. The policy input is specified as a string containing the * complete, valid JSON text of a permissions boundary policy. *

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

*/ private com.amazonaws.internal.SdkInternalList permissionsBoundaryPolicyInputList; /** *

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

*/ private com.amazonaws.internal.SdkInternalList actionNames; /** *

* A list of ARNs of Amazon Web Services 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. You can simulate resources that don't exist in your account. *

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

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. *

* *

* Simulation of resource-based policies isn't supported for IAM roles. *

* */ private com.amazonaws.internal.SdkInternalList resourceArns; /** *

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

* *

* Simulation of resource-based policies isn't supported for IAM roles. *

* */ private String resourcePolicy; /** *

* An Amazon Web Services account ID that specifies the owner of any simulated resource that does not identify its * owner in the resource ARN. Examples of resource ARNs include 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. *

*/ private String resourceOwner; /** *

* The ARN of the IAM user that you want to specify as the simulated caller of the API operations. If you do not * specify a CallerArn, it defaults to the ARN of the user that you specify in * PolicySourceArn, if you specified a user. If you include both a PolicySourceArn (for * example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, * arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the API operations as * Bob, as if Bob had David's policies. *

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

* CallerArn is required if you include a ResourcePolicy and the * PolicySourceArn is not the ARN for an IAM user. This is required so that the resource-based policy's * Principal element has a value to use in evaluating the policy. *

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. *

*/ private String callerArn; /** *

* 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 permissions policies, the corresponding value is supplied. *

*/ private com.amazonaws.internal.SdkInternalList contextEntries; /** *

* 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-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 *
*

*/ private String resourceHandlingOption; /** *

* 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, the number of items 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. *

*/ private Integer maxItems; /** *

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

*/ private String marker; /** *

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. *

* * @param policySourceArn * The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the * simulation. If you specify a user, group, or role, the simulation includes all policies that are * associated with that entity. If you specify a user, the simulation also includes all policies that are * attached to any groups the user belongs to.

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

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. */ public void setPolicySourceArn(String policySourceArn) { this.policySourceArn = policySourceArn; } /** *

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. *

* * @return The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the * simulation. If you specify a user, group, or role, the simulation includes all policies that are * associated with that entity. If you specify a user, the simulation also includes all policies that are * attached to any groups the user belongs to.

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. */ public String getPolicySourceArn() { return this.policySourceArn; } /** *

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. *

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. * @return Returns a reference to this object so that method calls can be chained together. */ public SimulatePrincipalPolicyRequest withPolicySourceArn(String policySourceArn) { setPolicySourceArn(policySourceArn); return this; } /** *

* An optional list of additional policy documents to include in the simulation. Each document is specified as a * string containing the complete, valid JSON text of an IAM policy. *

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

* * @return An optional list of additional policy documents to include in the simulation. Each document is specified * as a string containing the complete, valid JSON text of an IAM policy.

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

getPolicyInputList() { if (policyInputList == null) { policyInputList = new com.amazonaws.internal.SdkInternalList(); } return policyInputList; } /** *

* An optional list of additional policy documents to include in the simulation. Each document is specified as a * string containing the complete, valid JSON text of an IAM policy. *

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

* * @param policyInputList * An optional list of additional policy documents to include in the simulation. Each document is specified * as a string containing the complete, valid JSON text of an IAM policy.

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

policyInputList) { if (policyInputList == null) { this.policyInputList = null; return; } this.policyInputList = new com.amazonaws.internal.SdkInternalList(policyInputList); } /** *

* An optional list of additional policy documents to include in the simulation. Each document is specified as a * string containing the complete, valid JSON text of an IAM policy. *

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

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setPolicyInputList(java.util.Collection)} or {@link #withPolicyInputList(java.util.Collection)} if you * want to override the existing values. *

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

(policyInputList.length)); } for (String ele : policyInputList) { this.policyInputList.add(ele); } return this; } /** *

* An optional list of additional policy documents to include in the simulation. Each document is specified as a * string containing the complete, valid JSON text of an IAM policy. *

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

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

policyInputList) { setPolicyInputList(policyInputList); return this; } /** *

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

* * @return The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions * that the entity can have. You can input only one permissions boundary when you pass a policy to this * operation. An IAM entity can only have one permissions boundary in effect at a time. For example, if a * permissions boundary is attached to an entity and you pass in a different permissions boundary policy * using this parameter, then the new permissions boundary policy is used for the simulation. For more * information about permissions boundaries, see Permissions * boundaries for IAM entities in the IAM User Guide. The policy input is specified as a string * containing the complete, valid JSON text of a permissions boundary policy.

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

getPermissionsBoundaryPolicyInputList() { if (permissionsBoundaryPolicyInputList == null) { permissionsBoundaryPolicyInputList = new com.amazonaws.internal.SdkInternalList(); } return permissionsBoundaryPolicyInputList; } /** *

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

* * @param permissionsBoundaryPolicyInputList * The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions * that the entity can have. You can input only one permissions boundary when you pass a policy to this * operation. An IAM entity can only have one permissions boundary in effect at a time. For example, if a * permissions boundary is attached to an entity and you pass in a different permissions boundary policy * using this parameter, then the new permissions boundary policy is used for the simulation. For more * information about permissions boundaries, see Permissions * boundaries for IAM entities in the IAM User Guide. The policy input is specified as a string * containing the complete, valid JSON text of a permissions boundary policy.

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

permissionsBoundaryPolicyInputList) { if (permissionsBoundaryPolicyInputList == null) { this.permissionsBoundaryPolicyInputList = null; return; } this.permissionsBoundaryPolicyInputList = new com.amazonaws.internal.SdkInternalList(permissionsBoundaryPolicyInputList); } /** *

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

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setPermissionsBoundaryPolicyInputList(java.util.Collection)} or * {@link #withPermissionsBoundaryPolicyInputList(java.util.Collection)} if you want to override the existing * values. *

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

(permissionsBoundaryPolicyInputList.length)); } for (String ele : permissionsBoundaryPolicyInputList) { this.permissionsBoundaryPolicyInputList.add(ele); } return this; } /** *

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

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

permissionsBoundaryPolicyInputList) { setPermissionsBoundaryPolicyInputList(permissionsBoundaryPolicyInputList); return this; } /** *

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

* * @return A list of names of API operations to evaluate in the simulation. Each operation is evaluated for each * resource. Each operation must include the service identifier, such as iam:CreateUser. */ public java.util.List getActionNames() { if (actionNames == null) { actionNames = new com.amazonaws.internal.SdkInternalList(); } return actionNames; } /** *

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

* * @param actionNames * A list of names of API operations to evaluate in the simulation. Each operation is evaluated for each * resource. Each operation must include the service identifier, such as iam:CreateUser. */ public void setActionNames(java.util.Collection actionNames) { if (actionNames == null) { this.actionNames = null; return; } this.actionNames = new com.amazonaws.internal.SdkInternalList(actionNames); } /** *

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

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setActionNames(java.util.Collection)} or {@link #withActionNames(java.util.Collection)} if you want to * override the existing values. *

* * @param actionNames * A list of names of API operations to evaluate in the simulation. Each operation is evaluated for each * resource. Each operation must include the service identifier, such as iam:CreateUser. * @return Returns a reference to this object so that method calls can be chained together. */ public SimulatePrincipalPolicyRequest withActionNames(String... actionNames) { if (this.actionNames == null) { setActionNames(new com.amazonaws.internal.SdkInternalList(actionNames.length)); } for (String ele : actionNames) { this.actionNames.add(ele); } return this; } /** *

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

* * @param actionNames * A list of names of API operations to evaluate in the simulation. Each operation is evaluated for each * resource. Each operation must include the service identifier, such as iam:CreateUser. * @return Returns a reference to this object so that method calls can be chained together. */ public SimulatePrincipalPolicyRequest withActionNames(java.util.Collection actionNames) { setActionNames(actionNames); return this; } /** *

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. *

* *

* Simulation of resource-based policies isn't supported for IAM roles. *

* * * @return A list of ARNs of Amazon Web Services 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. You can * simulate resources that don't exist in your account.

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

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. *

* *

* Simulation of resource-based policies isn't supported for IAM roles. *

*/ public java.util.List getResourceArns() { if (resourceArns == null) { resourceArns = new com.amazonaws.internal.SdkInternalList(); } return resourceArns; } /** *

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. *

* *

* Simulation of resource-based policies isn't supported for IAM roles. *

* * * @param resourceArns * A list of ARNs of Amazon Web Services 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. You can simulate * resources that don't exist in your account.

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. *

* *

* Simulation of resource-based policies isn't supported for IAM roles. *

*/ public void setResourceArns(java.util.Collection resourceArns) { if (resourceArns == null) { this.resourceArns = null; return; } this.resourceArns = new com.amazonaws.internal.SdkInternalList(resourceArns); } /** *

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. *

* *

* Simulation of resource-based policies isn't supported for IAM roles. *

* *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setResourceArns(java.util.Collection)} or {@link #withResourceArns(java.util.Collection)} if you want to * override the existing values. *

* * @param resourceArns * A list of ARNs of Amazon Web Services 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. You can simulate * resources that don't exist in your account.

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. *

* *

* Simulation of resource-based policies isn't supported for IAM roles. *

* @return Returns a reference to this object so that method calls can be chained together. */ public SimulatePrincipalPolicyRequest withResourceArns(String... resourceArns) { if (this.resourceArns == null) { setResourceArns(new com.amazonaws.internal.SdkInternalList(resourceArns.length)); } for (String ele : resourceArns) { this.resourceArns.add(ele); } return this; } /** *

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. *

* *

* Simulation of resource-based policies isn't supported for IAM roles. *

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. *

* *

* Simulation of resource-based policies isn't supported for IAM roles. *

* @return Returns a reference to this object so that method calls can be chained together. */ public SimulatePrincipalPolicyRequest withResourceArns(java.util.Collection resourceArns) { setResourceArns(resourceArns); return this; } /** *

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

* *

* Simulation of resource-based policies isn't supported for IAM roles. *

* * * @param resourcePolicy * 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) *
*

* *

* Simulation of resource-based policies isn't supported for IAM roles. *

*/ public void setResourcePolicy(String resourcePolicy) { this.resourcePolicy = resourcePolicy; } /** *

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

* *

* Simulation of resource-based policies isn't supported for IAM roles. *

* * * @return 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) *
*

* *

* Simulation of resource-based policies isn't supported for IAM roles. *

*/ public String getResourcePolicy() { return this.resourcePolicy; } /** *

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

* *

* Simulation of resource-based policies isn't supported for IAM roles. *

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

* *

* Simulation of resource-based policies isn't supported for IAM roles. *

* @return Returns a reference to this object so that method calls can be chained together. */ public SimulatePrincipalPolicyRequest withResourcePolicy(String resourcePolicy) { setResourcePolicy(resourcePolicy); return this; } /** *

* * @param resourceOwner * An Amazon Web Services account ID that specifies the owner of any simulated resource that does not * identify its owner in the resource ARN. Examples of resource ARNs include 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. */ public void setResourceOwner(String resourceOwner) { this.resourceOwner = resourceOwner; } /** *

* * @return An Amazon Web Services account ID that specifies the owner of any simulated resource that does not * identify its owner in the resource ARN. Examples of resource ARNs include 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. */ public String getResourceOwner() { return this.resourceOwner; } /** *

* * @param resourceOwner * An Amazon Web Services account ID that specifies the owner of any simulated resource that does not * identify its owner in the resource ARN. Examples of resource ARNs include 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. * @return Returns a reference to this object so that method calls can be chained together. */ public SimulatePrincipalPolicyRequest withResourceOwner(String resourceOwner) { setResourceOwner(resourceOwner); return this; } /** *

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

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. *

* * @param callerArn * The ARN of the IAM user that you want to specify as the simulated caller of the API operations. If you do * not specify a CallerArn, it defaults to the ARN of the user that you specify in * PolicySourceArn, if you specified a user. If you include both a PolicySourceArn * (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for * example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the API * operations as Bob, as if Bob had David's policies.

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

* CallerArn is required if you include a ResourcePolicy and the * PolicySourceArn is not the ARN for an IAM user. This is required so that the resource-based * policy's Principal element has a value to use in evaluating the policy. *

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. */ public void setCallerArn(String callerArn) { this.callerArn = callerArn; } /** *

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

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. *

* * @return The ARN of the IAM user that you want to specify as the simulated caller of the API operations. If you do * not specify a CallerArn, it defaults to the ARN of the user that you specify in * PolicySourceArn, if you specified a user. If you include both a PolicySourceArn * (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for * example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the * API operations as Bob, as if Bob had David's policies.

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

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. */ public String getCallerArn() { return this.callerArn; } /** *

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

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. *

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

* For more information about ARNs, see Amazon Resource Names * (ARNs) in the Amazon Web Services General Reference. * @return Returns a reference to this object so that method calls can be chained together. */ public SimulatePrincipalPolicyRequest withCallerArn(String callerArn) { setCallerArn(callerArn); return this; } /** *

* * @return 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 permissions policies, the corresponding value is supplied. */ public java.util.List getContextEntries() { if (contextEntries == null) { contextEntries = new com.amazonaws.internal.SdkInternalList(); } return contextEntries; } /** *

* * @param contextEntries * 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 permissions policies, the corresponding value is supplied. */ public void setContextEntries(java.util.Collection contextEntries) { if (contextEntries == null) { this.contextEntries = null; return; } this.contextEntries = new com.amazonaws.internal.SdkInternalList(contextEntries); } /** *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setContextEntries(java.util.Collection)} or {@link #withContextEntries(java.util.Collection)} if you want * to override the existing values. *

* * @param contextEntries * 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 permissions policies, the corresponding value is supplied. * @return Returns a reference to this object so that method calls can be chained together. */ public SimulatePrincipalPolicyRequest withContextEntries(ContextEntry... contextEntries) { if (this.contextEntries == null) { setContextEntries(new com.amazonaws.internal.SdkInternalList(contextEntries.length)); } for (ContextEntry ele : contextEntries) { this.contextEntries.add(ele); } return this; } /** *

* * @param contextEntries * 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 permissions policies, the corresponding value is supplied. * @return Returns a reference to this object so that method calls can be chained together. */ public SimulatePrincipalPolicyRequest withContextEntries(java.util.Collection contextEntries) { setContextEntries(contextEntries); return this; } /** *

*
* 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 *
*

* * @param resourceHandlingOption * 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-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 *
*

*
* 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 *
*

* 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-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 *
*

*
* 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 *
*

* 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-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 *
*

IsTruncated

true

* If you do not include this parameter, the number of items 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. */ public void setMaxItems(Integer maxItems) { this.maxItems = maxItems; } /** *

IsTruncated

true

* If you do not include this parameter, the number of items 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. */ public Integer getMaxItems() { return this.maxItems; } /** *

IsTruncated

true

* If you do not include this parameter, the number of items 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. * @return Returns a reference to this object so that method calls can be chained together. */ public SimulatePrincipalPolicyRequest withMaxItems(Integer maxItems) { setMaxItems(maxItems); return this; } /** *

Marker