Package com.pulumi.aws.iam.inputs

Class GetPrincipalPolicySimulationPlainArgs

  • public final class GetPrincipalPolicySimulationPlainArgs
extends com.pulumi.resources.InvokeArgs

    • Method Detail

      • actionNames

        public java.util.List<java.lang.String> actionNames()
        Returns:
        A set of IAM action names to run simulations for. Each entry in this set adds an additional hypothetical request to the simulation. Action names consist of a service prefix and an action verb separated by a colon, such as `s3:GetObject`. Refer to [Actions, resources, and condition keys for AWS services](https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html) to see the full set of possible IAM action names across all AWS services.

      • additionalPoliciesJsons

        public java.util.Optional<java.util.List<java.lang.String>> additionalPoliciesJsons()
        Returns:
        A set of additional principal policy documents to include in the simulation. The simulator will behave as if each of these policies were associated with the object specified in `policySourceArn`, allowing you to test the effect of hypothetical policies not yet created.

      • callerArn

        public java.util.Optional<java.lang.String> callerArn()
        Returns:
        The ARN of an user that will appear as the "caller" of the simulated requests. If you do not specify `callerArn` then the simulation will use the `policySourceArn` instead, if it contains a user ARN.

      • contexts

        public java.util.Optional<java.util.List<GetPrincipalPolicySimulationContext>> contexts()
        Returns:
        Each `context` block defines an entry in the table of additional context keys in the simulated request. IAM uses context keys for both custom conditions and for interpolating dynamic request-specific values into policy values. If you use policies that include those features then you will need to provide suitable example values for those keys to achieve a realistic simulation.

      • permissionsBoundaryPoliciesJsons

        public java.util.Optional<java.util.List<java.lang.String>> permissionsBoundaryPoliciesJsons()
        Returns:
        A set of [permissions boundary policy documents](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) to include in the simulation.

      • policySourceArn

        public java.lang.String policySourceArn()
        Returns:
        The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the IAM user, group, or role whose policies will be included in the simulation. You must closely match the form of the real service request you are simulating in order to achieve a realistic result. You can use the following additional arguments to specify other characteristics of the simulated requests:

      • resourceArns

        public java.util.Optional<java.util.List<java.lang.String>> resourceArns()
        Returns:
        A set of ARNs of resources to include in the simulation. This argument is important for actions that have either required or optional resource types listed in [Actions, resources, and condition keys for AWS services](https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html), and you must provide ARNs that identify AWS objects of the appropriate types for the chosen actions. The policy simulator only automatically loads policies associated with the `policySourceArn`, so if your given resources have their own resource-level policy then you'll also need to provide that explicitly using the `resourcePolicyJson` argument to achieve a realistic simulation.

      • resourceHandlingOption

        public java.util.Optional<java.lang.String> resourceHandlingOption()
        Returns:
        Specifies a special simulation type to run. Some EC2 actions require special simulation behaviors and a particular set of resource ARNs to achieve a realistic result. For more details, see the `ResourceHandlingOption` request parameter for [the underlying `iam:SimulatePrincipalPolicy` action](https://docs.aws.amazon.com/IAM/latest/APIReference/API_SimulatePrincipalPolicy.html).

      • resourceOwnerAccountId

        public java.util.Optional<java.lang.String> resourceOwnerAccountId()
        Returns:
        An AWS account ID to use for any resource ARN in `resourceArns` that doesn't include its own AWS account ID. If unspecified, the simulator will use the account ID from the `callerArn` argument as a placeholder.

      • resourcePolicyJson

        public java.util.Optional<java.lang.String> resourcePolicyJson()
        Returns:
        An IAM policy document representing the resource-level policy of all of the resources specified in `resourceArns`. The policy simulator cannot automatically load policies that are associated with individual resources, as described in the documentation for `resourceArns` above.