Package com.pulumi.aws.iam

Class RoleArgs

  • public final class RoleArgs
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RoleArgs.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static RoleArgs Empty  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,​PolicyDocumentArgs>> assumeRolePolicy()  
      static RoleArgs.Builder builder()  
      static RoleArgs.Builder builder​(RoleArgs defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> forceDetachPolicies()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<RoleInlinePolicyArgs>>> inlinePolicies()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> managedPolicyArns()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> maxSessionDuration()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> namePrefix()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> path()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> permissionsBoundary()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • Empty

        public static final RoleArgs Empty

    • Method Detail

      • assumeRolePolicy

        public com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,​PolicyDocumentArgs>> assumeRolePolicy()
        Returns:
        Policy that grants an entity permission to assume the role. > **NOTE:** The `assumeRolePolicy` is very similar to but slightly different than a standard IAM policy and cannot use an `aws.iam.Policy` resource. However, it _can_ use an `aws.iam.getPolicyDocument` data source. See the example above of how this works. The following arguments are optional:

      • description

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()
        Returns:
        Description of the role.

      • forceDetachPolicies

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> forceDetachPolicies()
        Returns:
        Whether to force detaching any policies the role has before destroying it. Defaults to `false`.

      • inlinePolicies

        public java.util.Optional<com.pulumi.core.Output<java.util.List<RoleInlinePolicyArgs>>> inlinePolicies()
        Returns:
        Configuration block defining an exclusive set of IAM inline policies associated with the IAM role. See below. If no blocks are configured, Pulumi will not manage any inline policies in this resource. Configuring one empty block (i.e., `inlinePolicy {}`) will cause Pulumi to remove _all_ inline policies added out of band on `apply`.

      • managedPolicyArns

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> managedPolicyArns()
        Returns:
        Set of exclusive IAM managed policy ARNs to attach to the IAM role. If this attribute is not configured, Pulumi will ignore policy attachments to this resource. When configured, Pulumi will align the role's managed policy attachments with this set by attaching or detaching managed policies. Configuring an empty set (i.e., `managedPolicyArns = []`) will cause Pulumi to remove _all_ managed policy attachments.

      • maxSessionDuration

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> maxSessionDuration()
        Returns:
        Maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        Friendly name of the role. If omitted, the provider will assign a random, unique name. See [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) for more information.

      • namePrefix

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> namePrefix()
        Returns:
        Creates a unique friendly name beginning with the specified prefix. Conflicts with `name`.

      • path

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> path()
        Returns:
        Path to the role. See [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) for more information.

      • permissionsBoundary

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> permissionsBoundary()
        Returns:
        ARN of the policy that is used to set the permissions boundary for the role.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value mapping of tags for the IAM role. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.