AccountSubscription class
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 API response, changes made to these groups post-subscription will not be detected by this resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const subscription = new aws.quicksight.AccountSubscription("subscription", {
accountName: "quicksight-pulumi",
authenticationMethod: "IAM_AND_QUICKSIGHT",
edition: "ENTERPRISE",
notificationEmail: "notification@email.com",
});
import pulumi
import pulumi_aws as aws
subscription = aws.quicksight.AccountSubscription("subscription",
account_name="quicksight-pulumi",
authentication_method="IAM_AND_QUICKSIGHT",
edition="ENTERPRISE",
notification_email="notification@email.com")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var subscription = new Aws.Quicksight.AccountSubscription("subscription", new()
{
AccountName = "quicksight-pulumi",
AuthenticationMethod = "IAM_AND_QUICKSIGHT",
Edition = "ENTERPRISE",
NotificationEmail = "notification@email.com",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/quicksight"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := quicksight.NewAccountSubscription(ctx, "subscription", &quicksight.AccountSubscriptionArgs{
AccountName: pulumi.String("quicksight-pulumi"),
AuthenticationMethod: pulumi.String("IAM_AND_QUICKSIGHT"),
Edition: pulumi.String("ENTERPRISE"),
NotificationEmail: pulumi.String("notification@email.com"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_quicksight_accountsubscription" "subscription" {
account_name = "quicksight-pulumi"
authentication_method = "IAM_AND_QUICKSIGHT"
edition = "ENTERPRISE"
notification_email = "notification@email.com"
}
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());
}
}
resources:
subscription:
type: aws:quicksight:AccountSubscription
properties:
accountName: quicksight-pulumi
authenticationMethod: IAM_AND_QUICKSIGHT
edition: ENTERPRISE
notificationEmail: notification@email.com
Import
Using pulumi import, import a QuickSight Account Subscription using awsAccountId. For example:
$ pulumi import aws:quicksight/accountSubscription:AccountSubscription example "012345678901"
Constructors
- AccountSubscription(String name, {AccountSubscriptionArgs? args, CustomResourceOptions? options})
-
Creates a new AccountSubscription.
nameThe Pulumi resource name.argsArguments used to configure this AccountSubscription. The set of arguments for AccountSubscription.optionsResource options controlling this resource's behavior. - AccountSubscription.reference(String urn)
- Creates a typed reference to an existing AccountSubscription resource.
Properties
-
accountName
↔ Output<
String> -
Name of your Amazon QuickSight account. This name is unique over all of AWS, and it appears only when users sign in.
latefinal
-
accountSubscriptionStatus
↔ Output<
String> -
Status of the Amazon QuickSight account's subscription.
latefinal
-
activeDirectoryName
↔ Output<
String?> -
Name of your Active Directory. This field is required if
ACTIVE_DIRECTORYis the selected authentication method of the new Amazon QuickSight account.latefinal -
adminGroups
↔ Output<
List< String> ?> -
Admin group associated with your Active Directory or IAM Identity Center account. This field is required if
ACTIVE_DIRECTORYorIAM_IDENTITY_CENTERis the selected authentication method of the new Amazon QuickSight account.latefinal -
adminProGroups
↔ Output<
List< String> ?> -
Admin PRO group associated with your Active Directory or IAM Identity Center account.
latefinal
-
authenticationMethod
↔ Output<
String> -
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, andACTIVE_DIRECTORY.latefinal -
Author group associated with your Active Directory or IAM Identity Center account.
latefinal
-
Author PRO group associated with your Active Directory or IAM Identity Center account.
latefinal
-
awsAccountId
↔ Output<
String> -
AWS account ID. Defaults to automatically determined account ID of the Pulumi AWS provider.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
contactNumber
↔ Output<
String?> -
A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if
ENTERPRISE_AND_Qis the selected edition of the new Amazon QuickSight account.latefinal -
directoryId
↔ Output<
String?> -
Active Directory ID that is associated with your Amazon QuickSight account.
latefinal
-
edition
↔ Output<
String> -
Edition of Amazon QuickSight that you want your account to have. Currently, you can choose from
STANDARD,ENTERPRISEorENTERPRISE_AND_Q.latefinal -
emailAddress
↔ Output<
String?> -
Email address of the author of the Amazon QuickSight account to use for future communications. This field is required if
ENTERPRISE_AND_Qis the selected edition of the new Amazon QuickSight account.latefinal -
firstName
↔ Output<
String?> -
First name of the author of the Amazon QuickSight account to use for future communications. This field is required if
ENTERPRISE_AND_Qis the selected edition of the new Amazon QuickSight account.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
iamIdentityCenterInstanceArn
↔ Output<
String?> -
ARN for the IAM Identity Center instance.
latefinal
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
lastName
↔ Output<
String?> -
Last name of the author of the Amazon QuickSight account to use for future communications. This field is required if
ENTERPRISE_AND_Qis the selected edition of the new Amazon QuickSight account.latefinal -
notificationEmail
↔ Output<
String> -
Email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.
latefinal
-
readerGroups
↔ Output<
List< String> ?> -
Reader group associated with your Active Directory or IAM Identity Center account.
latefinal
-
readerProGroups
↔ Output<
List< String> ?> -
Reader PRO group associated with your Active Directory or IAM Identity Center account.
latefinal
-
realm
↔ Output<
String?> -
Realm of the Active Directory that is associated with your Amazon QuickSight account.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {AccountSubscriptionState? state, CustomResourceOptions? options}) → AccountSubscription -
Gets an existing AccountSubscription resource's state with the given
nameandid.