@Generated(value="software.amazon.awssdk:codegen") public final class SimulatePrincipalPolicyRequest extends IamRequest implements ToCopyableBuilder<SimulatePrincipalPolicyRequest.Builder,SimulatePrincipalPolicyRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
SimulatePrincipalPolicyRequest.Builder |
Modifier and Type | Method and Description |
---|---|
List<String> |
actionNames()
A list of names of API actions to evaluate in the simulation.
|
static SimulatePrincipalPolicyRequest.Builder |
builder() |
String |
callerArn()
The ARN of the IAM user that you want to specify as the simulated caller of the APIs.
|
List<ContextEntry> |
contextEntries()
A list of context keys and corresponding values for the simulation to use.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
marker()
Use this parameter only when paginating results and only after you receive a response indicating that the results
are truncated.
|
Integer |
maxItems()
(Optional) Use this only when paginating results to indicate the maximum number of items you want in the
response.
|
List<String> |
policyInputList()
An optional list of additional policy documents to include in the simulation.
|
String |
policySourceArn()
The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation.
|
List<String> |
resourceArns()
A list of ARNs of AWS resources to include in the simulation.
|
String |
resourceHandlingOption()
Specifies the type of simulation to run.
|
String |
resourceOwner()
An 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.
|
String |
resourcePolicy()
A resource-based policy to include in the simulation provided as a string.
|
static Class<? extends SimulatePrincipalPolicyRequest.Builder> |
serializableBuilderClass() |
SimulatePrincipalPolicyRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public String 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.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
public List<String> 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 any printable ASCII character ranging from the space character ( ) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).
public List<String> actionNames()
A list of names of API actions to evaluate in the simulation. Each action is evaluated for each resource. Each
action must include the service identifier, such as iam:CreateUser
.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
iam:CreateUser
.public List<String> resourceArns()
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.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
(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.
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
public String 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 any printable ASCII character ranging from the space character ( ) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).
The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).
public String resourceOwner()
An 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
.
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 callerArn()
The ARN of the IAM user that you want to specify as the simulated caller of the APIs. 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 APIs 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) and AWS Service Namespaces in the AWS General Reference.
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
APIs 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) and AWS Service Namespaces in the AWS General Reference.
public List<ContextEntry> 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 permission policies, the corresponding value is supplied.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String resourceHandlingOption()
Specifies the type of simulation to run. Different APIs 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 AWS 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
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 AWS 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
public Integer maxItems()
(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.
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.
public String marker()
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.
Marker
element in the response that you
received to indicate where the next call should start.public SimulatePrincipalPolicyRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<SimulatePrincipalPolicyRequest.Builder,SimulatePrincipalPolicyRequest>
toBuilder
in class IamRequest
public static SimulatePrincipalPolicyRequest.Builder builder()
public static Class<? extends SimulatePrincipalPolicyRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.