Package com.pulumi.aws.quicksight

Class AccountSubscription

  • public class AccountSubscription
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS QuickSight Account Subscription. > Due to the absence of the `adminGroup`, `authorGroup`, `readerGroup`, `adminProGroup`, `authorProGroup`, and `readerProGroup` fields in the [`DescribeAccountSettings`](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeAccountSettings.html) API response, changes made to these groups post-subscription will not be detected by this resource. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.quicksight.AccountSubscription;
 import com.pulumi.aws.quicksight.AccountSubscriptionArgs;
 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 subscription = new AccountSubscription("subscription", AccountSubscriptionArgs.builder()
             .accountName("quicksight-pulumi")
             .authenticationMethod("IAM_AND_QUICKSIGHT")
             .edition("ENTERPRISE")
             .notificationEmail("notification@email.com")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import a QuickSight Account Subscription using `awsAccountId`. For example: ```sh $ pulumi import aws:quicksight/accountSubscription:AccountSubscription example "012345678901" ```

    • 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> accountName()  
      com.pulumi.core.Output<java.lang.String> accountSubscriptionStatus()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> activeDirectoryName()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> adminGroups()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> adminProGroups()  
      com.pulumi.core.Output<java.lang.String> authenticationMethod()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> authorGroups()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> authorProGroups()  
      com.pulumi.core.Output<java.lang.String> awsAccountId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> contactNumber()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> directoryId()  
      com.pulumi.core.Output<java.lang.String> edition()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> emailAddress()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> firstName()  
      static AccountSubscription get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AccountSubscriptionState 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<java.lang.String>> iamIdentityCenterInstanceArn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> lastName()  
      com.pulumi.core.Output<java.lang.String> notificationEmail()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> readerGroups()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> readerProGroups()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> realm()  
      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

      • AccountSubscription

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

      • AccountSubscription

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

      • AccountSubscription

        public AccountSubscription​(java.lang.String name,
                           AccountSubscriptionArgs 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

      • accountName

        public com.pulumi.core.Output<java.lang.String> accountName()
        Returns:
        Name of your Amazon QuickSight account. This name is unique over all of AWS, and it appears only when users sign in.

      • accountSubscriptionStatus

        public com.pulumi.core.Output<java.lang.String> accountSubscriptionStatus()
        Returns:
        Status of the Amazon QuickSight account's subscription.

      • activeDirectoryName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> activeDirectoryName()
        Returns:
        Name of your Active Directory. This field is required if `ACTIVE_DIRECTORY` is the selected authentication method of the new Amazon QuickSight account.

      • adminGroups

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> adminGroups()
        Returns:
        Admin group associated with your Active Directory or IAM Identity Center account. Either this field or `adminProGroup` is required if `ACTIVE_DIRECTORY` or `IAM_IDENTITY_CENTER` is the selected authentication method of the new Amazon QuickSight account.

      • adminProGroups

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> adminProGroups()
        Returns:
        Admin PRO group associated with your Active Directory or IAM Identity Center account. Either this field or `adminGroup` is required if `ACTIVE_DIRECTORY` or `IAM_IDENTITY_CENTER` is the selected authentication method of the new Amazon QuickSight account.

      • authenticationMethod

        public com.pulumi.core.Output<java.lang.String> authenticationMethod()
        Returns:
        Method that you want to use to authenticate your Amazon QuickSight account. Currently, the valid values for this parameter are `IAM_AND_QUICKSIGHT`, `IAM_ONLY`, `IAM_IDENTITY_CENTER`, and `ACTIVE_DIRECTORY`.

      • authorGroups

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> authorGroups()
        Returns:
        Author group associated with your Active Directory or IAM Identity Center account.

      • authorProGroups

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> authorProGroups()
        Returns:
        Author PRO group associated with your Active Directory or IAM Identity Center account.

      • awsAccountId

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

      • contactNumber

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> contactNumber()
        Returns:
        10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if `ENTERPRISE_AND_Q` is the selected edition of the new Amazon QuickSight account.

      • directoryId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> directoryId()
        Returns:
        Active Directory ID that is associated with your Amazon QuickSight account.

      • edition

        public com.pulumi.core.Output<java.lang.String> edition()
        Returns:
        Edition of Amazon QuickSight that you want your account to have. Currently, you can choose from `STANDARD`, `ENTERPRISE` or `ENTERPRISE_AND_Q`.

      • emailAddress

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> emailAddress()
        Returns:
        Email address of the author of the Amazon QuickSight account to use for future communications. This field is required if `ENTERPRISE_AND_Q` is the selected edition of the new Amazon QuickSight account.

      • firstName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> firstName()
        Returns:
        First name of the author of the Amazon QuickSight account to use for future communications. This field is required if `ENTERPRISE_AND_Q` is the selected edition of the new Amazon QuickSight account.

      • iamIdentityCenterInstanceArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> iamIdentityCenterInstanceArn()
        Returns:
        ARN for the IAM Identity Center instance.

      • lastName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> lastName()
        Returns:
        Last name of the author of the Amazon QuickSight account to use for future communications. This field is required if `ENTERPRISE_AND_Q` is the selected edition of the new Amazon QuickSight account.

      • notificationEmail

        public com.pulumi.core.Output<java.lang.String> notificationEmail()
        Returns:
        Email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription. The following arguments are optional:

      • readerGroups

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> readerGroups()
        Returns:
        Reader group associated with your Active Directory or IAM Identity Center account.

      • readerProGroups

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> readerProGroups()
        Returns:
        Reader PRO group associated with your Active Directory or IAM Identity Center account.

      • realm

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> realm()
        Returns:
        Realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if `ACTIVE_DIRECTORY` is the selected authentication method of the new Amazon QuickSight account.

      • 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 AccountSubscription get​(java.lang.String name,
                                      com.pulumi.core.Output<java.lang.String> id,
                                      @Nullable
                                      AccountSubscriptionState 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.