Class SimulatePrincipalPolicyRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<SimulatePrincipalPolicyRequest.Builder,
SimulatePrincipalPolicyRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionA list of names of API operations to evaluate in the simulation.builder()
final String
The ARN of the IAM user that you want to specify as the simulated caller of the API operations.final List
<ContextEntry> A list of context keys and corresponding values for the simulation to use.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the ActionNames property.final boolean
For responses, this returns true if the service returned a value for the ContextEntries property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the PermissionsBoundaryPolicyInputList property.final boolean
For responses, this returns true if the service returned a value for the PolicyInputList property.final boolean
For responses, this returns true if the service returned a value for the ResourceArns property.final String
marker()
Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.final Integer
maxItems()
Use this only when paginating results to indicate the maximum number of items you want in the response.The IAM permissions boundary policy to simulate.An optional list of additional policy documents to include in the simulation.final String
The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation.A list of ARNs of Amazon Web Services resources to include in the simulation.final String
Specifies the type of simulation to run.final String
An Amazon Web Services account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN.final String
A resource-based policy to include in the simulation provided as a string.static Class
<? extends SimulatePrincipalPolicyRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.
- Returns:
- 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.
-
hasPolicyInputList
public final boolean hasPolicyInputList()For responses, this returns true if the service returned a value for the PolicyInputList property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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 (
-
The printable characters in the Basic Latin and Latin-1 Supplement character set (through
ÿ
) -
The special characters tab (
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPolicyInputList()
method.- Returns:
- 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 (
-
The printable characters in the Basic Latin and Latin-1 Supplement character set (through
ÿ
) -
The special characters tab (
-
-
-
hasPermissionsBoundaryPolicyInputList
public final boolean hasPermissionsBoundaryPolicyInputList()For responses, this returns true if the service returned a value for the PermissionsBoundaryPolicyInputList property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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 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 (
-
The printable characters in the Basic Latin and Latin-1 Supplement character set (through
ÿ
) -
The special characters tab (
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPermissionsBoundaryPolicyInputList()
method.- Returns:
- 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 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 (
-
The printable characters in the Basic Latin and Latin-1 Supplement character set (through
ÿ
) -
The special characters tab (
-
-
-
hasActionNames
public final boolean hasActionNames()For responses, this returns true if the service returned a value for the ActionNames property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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
.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasActionNames()
method.- Returns:
- 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
.
-
hasResourceArns
public final boolean hasResourceArns()For responses, this returns true if the service returned a value for the ResourceArns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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 theActionNames
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasResourceArns()
method.- Returns:
- 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 theActionNames
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.
-
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 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 (
-
The printable characters in the Basic Latin and Latin-1 Supplement character set (through
ÿ
) -
The special characters tab (
Simulation of resource-based policies isn't supported for IAM roles.
- Returns:
- 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 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 (
-
The printable characters in the Basic Latin and Latin-1 Supplement character set (through
ÿ
) -
The special characters tab (
Simulation of resource-based policies isn't supported for IAM roles.
-
-
-
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 anyResourcePolicy
included in the simulation. If theResourceOwner
parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided inCallerArn
. 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 userCallerArn
.- Returns:
- 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 anyResourcePolicy
included in the simulation. If theResourceOwner
parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided inCallerArn
. 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 userCallerArn
.
-
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 inPolicySourceArn
, if you specified a user. If you include both aPolicySourceArn
(for example,arn:aws:iam::123456789012:user/David
) and aCallerArn
(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 aResourcePolicy
and thePolicySourceArn
is not the ARN for an IAM user. This is required so that the resource-based policy'sPrincipal
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.
- Returns:
- 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 inPolicySourceArn
, if you specified a user. If you include both aPolicySourceArn
(for example,arn:aws:iam::123456789012:user/David
) and aCallerArn
(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 aResourcePolicy
and thePolicySourceArn
is not the ARN for an IAM user. This is required so that the resource-based policy'sPrincipal
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.
-
hasContextEntries
public final boolean hasContextEntries()For responses, this returns true if the service returned a value for the ContextEntries property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasContextEntries()
method.- Returns:
- 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.
-
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 Amazon 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 Amazon 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 Amazon 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
- Returns:
- 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 Amazon 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 Amazon 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 Amazon 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
-
-
-
maxItems
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 istrue
.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 returnstrue
, andMarker
contains a value to include in the subsequent call that tells the service where to continue from.- Returns:
- 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 istrue
.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 returnstrue
, andMarker
contains a value to include in the subsequent call that tells the service where to continue from.
-
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.- Returns:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<SimulatePrincipalPolicyRequest.Builder,
SimulatePrincipalPolicyRequest> - Specified by:
toBuilder
in classIamRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-