Package com.pulumi.aws.quicksight

Class IamPolicyAssignment

  • public class IamPolicyAssignment
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS QuickSight IAM Policy Assignment. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.quicksight.IamPolicyAssignment;
 import com.pulumi.aws.quicksight.IamPolicyAssignmentArgs;
 import com.pulumi.aws.quicksight.inputs.IamPolicyAssignmentIdentitiesArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new IamPolicyAssignment("example", IamPolicyAssignmentArgs.builder()
             .identities(IamPolicyAssignmentIdentitiesArgs.builder()
                 .users(exampleAwsQuicksightUser.userName())
                 .build())
             .assignmentName("example")
             .assignmentStatus("ENABLED")
             .policyArn(exampleAwsIamPolicy.arn())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import QuickSight IAM Policy Assignment using the AWS account ID, namespace, and assignment name separated by commas (`,`). For example: ```sh $ pulumi import aws:quicksight/iamPolicyAssignment:IamPolicyAssignment example 123456789012,default,example ```

    • Nested Class Summary

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

        com.pulumi.resources.CustomResource.CustomResourceInternal

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

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> assignmentId()  
      com.pulumi.core.Output<java.lang.String> assignmentName()  
      com.pulumi.core.Output<java.lang.String> assignmentStatus()  
      com.pulumi.core.Output<java.lang.String> awsAccountId()  
      static IamPolicyAssignment get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, IamPolicyAssignmentState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<IamPolicyAssignmentIdentities>> identities()  
      com.pulumi.core.Output<java.lang.String> namespace()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> policyArn()  
      com.pulumi.core.Output<java.lang.String> region()  

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

        getId, id, idFuture

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

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • IamPolicyAssignment

        public IamPolicyAssignment​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • IamPolicyAssignment

        public IamPolicyAssignment​(java.lang.String name,
                           IamPolicyAssignmentArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • IamPolicyAssignment

        public IamPolicyAssignment​(java.lang.String name,
                           IamPolicyAssignmentArgs args,
                           @Nullable
                           com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • assignmentId

        public com.pulumi.core.Output<java.lang.String> assignmentId()
        Returns:
        Assignment ID.

      • assignmentName

        public com.pulumi.core.Output<java.lang.String> assignmentName()
        Returns:
        Name of the assignment.

      • assignmentStatus

        public com.pulumi.core.Output<java.lang.String> assignmentStatus()
        Returns:
        Status of the assignment. Valid values are `ENABLED`, `DISABLED`, and `DRAFT`. The following arguments are optional:

      • awsAccountId

        public com.pulumi.core.Output<java.lang.String> awsAccountId()
        Returns:
        AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.

      • identities

        public com.pulumi.core.Output<java.util.Optional<IamPolicyAssignmentIdentities>> identities()
        Returns:
        Amazon QuickSight users, groups, or both to assign the policy to. See `identities` block.

      • namespace

        public com.pulumi.core.Output<java.lang.String> namespace()
        Returns:
        Namespace that contains the assignment. Defaults to `default`.

      • policyArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> policyArn()
        Returns:
        ARN of the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • get

        public static IamPolicyAssignment get​(java.lang.String name,
                                      com.pulumi.core.Output<java.lang.String> id,
                                      @Nullable
                                      IamPolicyAssignmentState state,
                                      @Nullable
                                      com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.