Interface CreateAccountSubscriptionRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateAccountSubscriptionRequest.Builder,
,CreateAccountSubscriptionRequest> QuickSightRequest.Builder
,SdkBuilder<CreateAccountSubscriptionRequest.Builder,
,CreateAccountSubscriptionRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateAccountSubscriptionRequest
-
Method Summary
Modifier and TypeMethodDescriptionaccountName
(String accountName) The name of your Amazon QuickSight account.activeDirectoryName
(String activeDirectoryName) The name of your Active Directory.adminGroup
(String... adminGroup) The admin group associated with your Active Directory.adminGroup
(Collection<String> adminGroup) The admin group associated with your Active Directory.authenticationMethod
(String authenticationMethod) The method that you want to use to authenticate your Amazon QuickSight account.authenticationMethod
(AuthenticationMethodOption authenticationMethod) The method that you want to use to authenticate your Amazon QuickSight account.authorGroup
(String... authorGroup) The author group associated with your Active Directory.authorGroup
(Collection<String> authorGroup) The author group associated with your Active Directory.awsAccountId
(String awsAccountId) The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.contactNumber
(String contactNumber) A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications.directoryId
(String directoryId) The ID of the Active Directory that is associated with your Amazon QuickSight account.The edition of Amazon QuickSight that you want your account to have.The edition of Amazon QuickSight that you want your account to have.emailAddress
(String emailAddress) The email address of the author of the Amazon QuickSight account to use for future communications.The first name of the author of the Amazon QuickSight account to use for future communications.The last name of the author of the Amazon QuickSight account to use for future communications.notificationEmail
(String notificationEmail) The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.readerGroup
(String... readerGroup) The reader group associated with your Active Direcrtory.readerGroup
(Collection<String> readerGroup) The reader group associated with your Active Direcrtory.The realm of the Active Directory that is associated with your Amazon QuickSight account.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.quicksight.model.QuickSightRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
edition
The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from
ENTERPRISE
orENTERPRISE_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 fromENTERPRISE
orENTERPRISE_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
The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from
ENTERPRISE
orENTERPRISE_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 fromENTERPRISE
orENTERPRISE_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
The 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
, andACTIVE_DIRECTORY
.If you choose
ACTIVE_DIRECTORY
, provide anActiveDirectoryName
and anAdminGroup
associated with your Active Directory.- Parameters:
authenticationMethod
- The method that you want to use to authenticate your Amazon QuickSight account. Currently, the valid values for this parameter areIAM_AND_QUICKSIGHT
,IAM_ONLY
, andACTIVE_DIRECTORY
.If you choose
ACTIVE_DIRECTORY
, provide anActiveDirectoryName
and anAdminGroup
associated with your Active Directory.- 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. Currently, the valid values for this parameter are
IAM_AND_QUICKSIGHT
,IAM_ONLY
, andACTIVE_DIRECTORY
.If you choose
ACTIVE_DIRECTORY
, provide anActiveDirectoryName
and anAdminGroup
associated with your Active Directory.- Parameters:
authenticationMethod
- The method that you want to use to authenticate your Amazon QuickSight account. Currently, the valid values for this parameter areIAM_AND_QUICKSIGHT
,IAM_ONLY
, andACTIVE_DIRECTORY
.If you choose
ACTIVE_DIRECTORY
, provide anActiveDirectoryName
and anAdminGroup
associated with your Active Directory.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 changeAccountName
value after the Amazon QuickSight account is created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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 ifACTIVE_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
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 ifACTIVE_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
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
The admin group associated with your Active Directory. This field is required if
ACTIVE_DIRECTORY
is the selected authentication method of the new Amazon QuickSight account. 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. This field is required ifACTIVE_DIRECTORY
is the selected authentication method of the new Amazon QuickSight account. 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
The admin group associated with your Active Directory. This field is required if
ACTIVE_DIRECTORY
is the selected authentication method of the new Amazon QuickSight account. 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. This field is required ifACTIVE_DIRECTORY
is the selected authentication method of the new Amazon QuickSight account. 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
The author group associated with your Active Directory. 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. 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
The author group associated with your Active Directory. 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. 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
The reader group associated with your Active Direcrtory. 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 Direcrtory. 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
The reader group associated with your Active Direcrtory. 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 Direcrtory. 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
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 ifENTERPPRISE_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
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 ifENTERPPRISE_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
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 ifENTERPPRISE_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
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 ifENTERPPRISE_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.
-
overrideConfiguration
CreateAccountSubscriptionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-