pulumi-aws-kotlin/com.pulumi.aws.quicksight.kotlin/AccountSubscriptionArgs

AccountSubscriptionArgs

data class AccountSubscriptionArgs(val accountName: Output<String>? = null, val activeDirectoryName: Output<String>? = null, val adminGroups: Output<List<String>>? = null, val authenticationMethod: Output<String>? = null, val authorGroups: Output<List<String>>? = null, val awsAccountId: Output<String>? = null, val contactNumber: Output<String>? = null, val directoryId: Output<String>? = null, val edition: Output<String>? = null, val emailAddress: Output<String>? = null, val firstName: Output<String>? = null, val lastName: Output<String>? = null, val notificationEmail: Output<String>? = null, val readerGroups: Output<List<String>>? = null, val realm: Output<String>? = null) : ConvertibleToJava<AccountSubscriptionArgs>

Resource for managing an AWS QuickSight Account Subscription.

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/v6/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
	})
}

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.List;
import java.util.ArrayList;
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

You cannot import this resource.

Constructors

AccountSubscriptionArgs

fun AccountSubscriptionArgs(accountName: Output<String>? = null, activeDirectoryName: Output<String>? = null, adminGroups: Output<List<String>>? = null, authenticationMethod: Output<String>? = null, authorGroups: Output<List<String>>? = null, awsAccountId: Output<String>? = null, contactNumber: Output<String>? = null, directoryId: Output<String>? = null, edition: Output<String>? = null, emailAddress: Output<String>? = null, firstName: Output<String>? = null, lastName: Output<String>? = null, notificationEmail: Output<String>? = null, readerGroups: Output<List<String>>? = null, realm: Output<String>? = null)

Functions

toJava

open override fun toJava(): AccountSubscriptionArgs

Properties

accountName

val accountName: Output<String>? = null

Name of your Amazon QuickSight account. This name is unique over all of AWS, and it appears only when users sign in.

activeDirectoryName

val activeDirectoryName: Output<String>? = null

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

adminGroups

val adminGroups: Output<List<String>>? = null

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.

authenticationMethod

val authenticationMethod: Output<String>? = null

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

val authorGroups: Output<List<String>>? = null

Author group associated with your Active Directory.

awsAccountId

val awsAccountId: Output<String>? = null

AWS account ID hosting the QuickSight account. Default to provider account.

contactNumber

val contactNumber: Output<String>? = null

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.

directoryId

val directoryId: Output<String>? = null

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

edition

val edition: Output<String>? = null

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

emailAddress

val emailAddress: Output<String>? = null

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.

firstName

val firstName: Output<String>? = null

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.

lastName

val lastName: Output<String>? = null

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.

notificationEmail

val notificationEmail: Output<String>? = null

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

val readerGroups: Output<List<String>>? = null

Reader group associated with your Active Direcrtory.

realm

val realm: Output<String>? = null

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