Package software.amazon.awssdk.services.quicksight.model

Interface CreateAccountSubscriptionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateAccountSubscriptionRequest.Builder,CreateAccountSubscriptionRequest>, QuickSightRequest.Builder, SdkBuilder<CreateAccountSubscriptionRequest.Builder,CreateAccountSubscriptionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateAccountSubscriptionRequest
public static interface CreateAccountSubscriptionRequest.Builder extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<CreateAccountSubscriptionRequest.Builder,CreateAccountSubscriptionRequest>

  • Method Details

    • edition

      CreateAccountSubscriptionRequest.Builder edition(String edition)

      The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from ENTERPRISE or ENTERPRISE_AND_Q.

      If you choose ENTERPRISE_AND_Q, the following parameters are required:

      • FirstName

      • LastName

      • EmailAddress

      • ContactNumber

      Parameters:
      edition - The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from ENTERPRISE or ENTERPRISE_AND_Q.

      If you choose ENTERPRISE_AND_Q, the following parameters are required:

      • FirstName

      • LastName

      • EmailAddress

      • ContactNumber

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • edition

      CreateAccountSubscriptionRequest.Builder edition(Edition edition)

      The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from ENTERPRISE or ENTERPRISE_AND_Q.

      If you choose ENTERPRISE_AND_Q, the following parameters are required:

      • FirstName

      • LastName

      • EmailAddress

      • ContactNumber

      Parameters:
      edition - The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from ENTERPRISE or ENTERPRISE_AND_Q.

      If you choose ENTERPRISE_AND_Q, the following parameters are required:

      • FirstName

      • LastName

      • EmailAddress

      • ContactNumber

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authenticationMethod

      CreateAccountSubscriptionRequest.Builder authenticationMethod(String authenticationMethod)

      The method that you want to use to authenticate your Amazon QuickSight account.

      If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName and an AdminGroup associated with your Active Directory.

      If you choose IAM_IDENTITY_CENTER, provide an AdminGroup associated with your IAM Identity Center account.

      Parameters:
      authenticationMethod - The method that you want to use to authenticate your Amazon QuickSight account.

      If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName and an AdminGroup associated with your Active Directory.

      If you choose IAM_IDENTITY_CENTER, provide an AdminGroup associated with your IAM Identity Center account.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authenticationMethod

      CreateAccountSubscriptionRequest.Builder authenticationMethod(AuthenticationMethodOption authenticationMethod)

      The method that you want to use to authenticate your Amazon QuickSight account.

      If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName and an AdminGroup associated with your Active Directory.

      If you choose IAM_IDENTITY_CENTER, provide an AdminGroup associated with your IAM Identity Center account.

      Parameters:
      authenticationMethod - The method that you want to use to authenticate your Amazon QuickSight account.

      If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName and an AdminGroup associated with your Active Directory.

      If you choose IAM_IDENTITY_CENTER, provide an AdminGroup associated with your IAM Identity Center account.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • awsAccountId

      CreateAccountSubscriptionRequest.Builder awsAccountId(String awsAccountId)

      The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.

      Parameters:
      awsAccountId - The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accountName

      CreateAccountSubscriptionRequest.Builder accountName(String accountName)

      The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change AccountName value after the Amazon QuickSight account is created.

      Parameters:
      accountName - The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change AccountName value after the Amazon QuickSight account is created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notificationEmail

      CreateAccountSubscriptionRequest.Builder notificationEmail(String notificationEmail)

      The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.

      Parameters:
      notificationEmail - The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • activeDirectoryName

      CreateAccountSubscriptionRequest.Builder activeDirectoryName(String activeDirectoryName)

      The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

      Parameters:
      activeDirectoryName - The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • realm

      CreateAccountSubscriptionRequest.Builder realm(String realm)

      The 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.

      Parameters:
      realm - The 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • directoryId

      CreateAccountSubscriptionRequest.Builder directoryId(String directoryId)

      The ID of the Active Directory that is associated with your Amazon QuickSight account.

      Parameters:
      directoryId - The ID of the Active Directory that is associated with your Amazon QuickSight account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • adminGroup

      CreateAccountSubscriptionRequest.Builder adminGroup(Collection<String> adminGroup)

      The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Parameters:
      adminGroup - The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • adminGroup

      CreateAccountSubscriptionRequest.Builder adminGroup(String... adminGroup)

      The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Parameters:
      adminGroup - The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authorGroup

      CreateAccountSubscriptionRequest.Builder authorGroup(Collection<String> authorGroup)

      The author group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Parameters:
      authorGroup - The author group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authorGroup

      CreateAccountSubscriptionRequest.Builder authorGroup(String... authorGroup)

      The author group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Parameters:
      authorGroup - The author group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • readerGroup

      CreateAccountSubscriptionRequest.Builder readerGroup(Collection<String> readerGroup)

      The reader group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Parameters:
      readerGroup - The reader group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • readerGroup

      CreateAccountSubscriptionRequest.Builder readerGroup(String... readerGroup)

      The reader group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Parameters:
      readerGroup - The reader group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • adminProGroup

      CreateAccountSubscriptionRequest.Builder adminProGroup(Collection<String> adminProGroup)

      The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Parameters:
      adminProGroup - The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • adminProGroup

      CreateAccountSubscriptionRequest.Builder adminProGroup(String... adminProGroup)

      The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Parameters:
      adminProGroup - The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authorProGroup

      CreateAccountSubscriptionRequest.Builder authorProGroup(Collection<String> authorProGroup)

      The author pro group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Parameters:
      authorProGroup - The author pro group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authorProGroup

      CreateAccountSubscriptionRequest.Builder authorProGroup(String... authorProGroup)

      The author pro group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Parameters:
      authorProGroup - The author pro group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • readerProGroup

      CreateAccountSubscriptionRequest.Builder readerProGroup(Collection<String> readerProGroup)

      The reader pro group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Parameters:
      readerProGroup - The reader pro group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • readerProGroup

      CreateAccountSubscriptionRequest.Builder readerProGroup(String... readerProGroup)

      The reader pro group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Parameters:
      readerProGroup - The reader pro group associated with your Active Directory or IAM Identity Center account.

      For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • firstName

      CreateAccountSubscriptionRequest.Builder firstName(String firstName)

      The first name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.

      Parameters:
      firstName - The first name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastName

      CreateAccountSubscriptionRequest.Builder lastName(String lastName)

      The last name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.

      Parameters:
      lastName - The last name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • emailAddress

      CreateAccountSubscriptionRequest.Builder emailAddress(String emailAddress)

      The email address of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.

      Parameters:
      emailAddress - The email address of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contactNumber

      CreateAccountSubscriptionRequest.Builder contactNumber(String contactNumber)

      A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.

      Parameters:
      contactNumber - A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • iamIdentityCenterInstanceArn

      CreateAccountSubscriptionRequest.Builder iamIdentityCenterInstanceArn(String iamIdentityCenterInstanceArn)

      The Amazon Resource Name (ARN) for the IAM Identity Center instance.

      Parameters:
      iamIdentityCenterInstanceArn - The Amazon Resource Name (ARN) for the IAM Identity Center instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateAccountSubscriptionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateAccountSubscriptionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.