Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. quicksight
  5. AccountSubscription
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.quicksight.AccountSubscription

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    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")

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

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

    Create AccountSubscription Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AccountSubscription(name: string, args: AccountSubscriptionArgs, opts?: CustomResourceOptions);
    @overload
def AccountSubscription(resource_name: str,
                        args: AccountSubscriptionArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def AccountSubscription(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        account_name: Optional[str] = None,
                        notification_email: Optional[str] = None,
                        edition: Optional[str] = None,
                        authentication_method: Optional[str] = None,
                        author_groups: Optional[Sequence[str]] = None,
                        aws_account_id: Optional[str] = None,
                        contact_number: Optional[str] = None,
                        directory_id: Optional[str] = None,
                        admin_groups: Optional[Sequence[str]] = None,
                        email_address: Optional[str] = None,
                        first_name: Optional[str] = None,
                        iam_identity_center_instance_arn: Optional[str] = None,
                        last_name: Optional[str] = None,
                        active_directory_name: Optional[str] = None,
                        reader_groups: Optional[Sequence[str]] = None,
                        realm: Optional[str] = None)
    func NewAccountSubscription(ctx *Context, name string, args AccountSubscriptionArgs, opts ...ResourceOption) (*AccountSubscription, error)
    public AccountSubscription(string name, AccountSubscriptionArgs args, CustomResourceOptions? opts = null)
    public AccountSubscription(String name, AccountSubscriptionArgs args)
public AccountSubscription(String name, AccountSubscriptionArgs args, CustomResourceOptions options)

    type: aws:quicksight:AccountSubscription
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AccountSubscriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AccountSubscriptionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AccountSubscriptionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccountSubscriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccountSubscriptionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var accountSubscriptionResource = new Aws.Quicksight.AccountSubscription("accountSubscriptionResource", new()
{
    AccountName = "string",
    NotificationEmail = "string",
    Edition = "string",
    AuthenticationMethod = "string",
    AuthorGroups = new[]
    {
        "string",
    },
    AwsAccountId = "string",
    ContactNumber = "string",
    DirectoryId = "string",
    AdminGroups = new[]
    {
        "string",
    },
    EmailAddress = "string",
    FirstName = "string",
    IamIdentityCenterInstanceArn = "string",
    LastName = "string",
    ActiveDirectoryName = "string",
    ReaderGroups = new[]
    {
        "string",
    },
    Realm = "string",
});

    example, err := quicksight.NewAccountSubscription(ctx, "accountSubscriptionResource", &quicksight.AccountSubscriptionArgs{
	AccountName:          pulumi.String("string"),
	NotificationEmail:    pulumi.String("string"),
	Edition:              pulumi.String("string"),
	AuthenticationMethod: pulumi.String("string"),
	AuthorGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	AwsAccountId:  pulumi.String("string"),
	ContactNumber: pulumi.String("string"),
	DirectoryId:   pulumi.String("string"),
	AdminGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	EmailAddress:                 pulumi.String("string"),
	FirstName:                    pulumi.String("string"),
	IamIdentityCenterInstanceArn: pulumi.String("string"),
	LastName:                     pulumi.String("string"),
	ActiveDirectoryName:          pulumi.String("string"),
	ReaderGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	Realm: pulumi.String("string"),
})

    var accountSubscriptionResource = new AccountSubscription("accountSubscriptionResource", AccountSubscriptionArgs.builder()
    .accountName("string")
    .notificationEmail("string")
    .edition("string")
    .authenticationMethod("string")
    .authorGroups("string")
    .awsAccountId("string")
    .contactNumber("string")
    .directoryId("string")
    .adminGroups("string")
    .emailAddress("string")
    .firstName("string")
    .iamIdentityCenterInstanceArn("string")
    .lastName("string")
    .activeDirectoryName("string")
    .readerGroups("string")
    .realm("string")
    .build());

    account_subscription_resource = aws.quicksight.AccountSubscription("accountSubscriptionResource",
    account_name="string",
    notification_email="string",
    edition="string",
    authentication_method="string",
    author_groups=["string"],
    aws_account_id="string",
    contact_number="string",
    directory_id="string",
    admin_groups=["string"],
    email_address="string",
    first_name="string",
    iam_identity_center_instance_arn="string",
    last_name="string",
    active_directory_name="string",
    reader_groups=["string"],
    realm="string")

    const accountSubscriptionResource = new aws.quicksight.AccountSubscription("accountSubscriptionResource", {
    accountName: "string",
    notificationEmail: "string",
    edition: "string",
    authenticationMethod: "string",
    authorGroups: ["string"],
    awsAccountId: "string",
    contactNumber: "string",
    directoryId: "string",
    adminGroups: ["string"],
    emailAddress: "string",
    firstName: "string",
    iamIdentityCenterInstanceArn: "string",
    lastName: "string",
    activeDirectoryName: "string",
    readerGroups: ["string"],
    realm: "string",
});

    type: aws:quicksight:AccountSubscription
properties:
    accountName: string
    activeDirectoryName: string
    adminGroups:
        - string
    authenticationMethod: string
    authorGroups:
        - string
    awsAccountId: string
    contactNumber: string
    directoryId: string
    edition: string
    emailAddress: string
    firstName: string
    iamIdentityCenterInstanceArn: string
    lastName: string
    notificationEmail: string
    readerGroups:
        - string
    realm: string

    AccountSubscription Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AccountSubscription resource accepts the following input properties:

    AccountName string
    Name of your Amazon QuickSight account. This name is unique over all of AWS, and it appears only when users sign in.
    AuthenticationMethod 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, and ACTIVE_DIRECTORY.
    Edition string
    Edition of Amazon QuickSight that you want your account to have. Currently, you can choose from STANDARD, ENTERPRISE or ENTERPRISE_AND_Q.
    NotificationEmail string

    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:

    ActiveDirectoryName string
    Name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
    AdminGroups List<string>
    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.
    AuthorGroups List<string>
    Author group associated with your Active Directory.
    AwsAccountId string
    AWS account ID hosting the QuickSight account. Default to provider account.
    ContactNumber string
    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 string
    Active Directory ID that is associated with your Amazon QuickSight account.
    EmailAddress string
    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 string
    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.
    IamIdentityCenterInstanceArn string
    The Amazon Resource Name (ARN) for the IAM Identity Center instance.
    LastName string
    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.
    ReaderGroups List<string>
    Reader group associated with your Active Direcrtory.
    Realm string
    Realm of the Active Directory that is associated with your Amazon QuickSight account.
    AccountName string
    Name of your Amazon QuickSight account. This name is unique over all of AWS, and it appears only when users sign in.
    AuthenticationMethod 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, and ACTIVE_DIRECTORY.
    Edition string
    Edition of Amazon QuickSight that you want your account to have. Currently, you can choose from STANDARD, ENTERPRISE or ENTERPRISE_AND_Q.
    NotificationEmail string

    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:

    ActiveDirectoryName string
    Name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
    AdminGroups []string
    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.
    AuthorGroups []string
    Author group associated with your Active Directory.
    AwsAccountId string
    AWS account ID hosting the QuickSight account. Default to provider account.
    ContactNumber string
    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 string
    Active Directory ID that is associated with your Amazon QuickSight account.
    EmailAddress string
    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 string
    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.
    IamIdentityCenterInstanceArn string
    The Amazon Resource Name (ARN) for the IAM Identity Center instance.
    LastName string
    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.
    ReaderGroups []string
    Reader group associated with your Active Direcrtory.
    Realm string
    Realm of the Active Directory that is associated with your Amazon QuickSight account.
    accountName String
    Name of your Amazon QuickSight account. This name is unique over all of AWS, and it appears only when users sign in.
    authenticationMethod 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, and ACTIVE_DIRECTORY.
    edition String
    Edition of Amazon QuickSight that you want your account to have. Currently, you can choose from STANDARD, ENTERPRISE or ENTERPRISE_AND_Q.
    notificationEmail String

    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:

    activeDirectoryName String
    Name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
    adminGroups List<String>
    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.
    authorGroups List<String>
    Author group associated with your Active Directory.
    awsAccountId String
    AWS account ID hosting the QuickSight account. Default to provider account.
    contactNumber String
    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 String
    Active Directory ID that is associated with your Amazon QuickSight account.
    emailAddress String
    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 String
    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.
    iamIdentityCenterInstanceArn String
    The Amazon Resource Name (ARN) for the IAM Identity Center instance.
    lastName String
    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.
    readerGroups List<String>
    Reader group associated with your Active Direcrtory.
    realm String
    Realm of the Active Directory that is associated with your Amazon QuickSight account.
    accountName string
    Name of your Amazon QuickSight account. This name is unique over all of AWS, and it appears only when users sign in.
    authenticationMethod 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, and ACTIVE_DIRECTORY.
    edition string
    Edition of Amazon QuickSight that you want your account to have. Currently, you can choose from STANDARD, ENTERPRISE or ENTERPRISE_AND_Q.
    notificationEmail string

    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:

    activeDirectoryName string
    Name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
    adminGroups string[]
    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.
    authorGroups string[]
    Author group associated with your Active Directory.
    awsAccountId string
    AWS account ID hosting the QuickSight account. Default to provider account.
    contactNumber string
    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 string
    Active Directory ID that is associated with your Amazon QuickSight account.
    emailAddress string
    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 string
    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.
    iamIdentityCenterInstanceArn string
    The Amazon Resource Name (ARN) for the IAM Identity Center instance.
    lastName string
    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.
    readerGroups string[]
    Reader group associated with your Active Direcrtory.
    realm string
    Realm of the Active Directory that is associated with your Amazon QuickSight account.
    account_name str
    Name of your Amazon QuickSight account. This name is unique over all of AWS, and it appears only when users sign in.
    authentication_method str
    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.
    edition str
    Edition of Amazon QuickSight that you want your account to have. Currently, you can choose from STANDARD, ENTERPRISE or ENTERPRISE_AND_Q.
    notification_email str

    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:

    active_directory_name str
    Name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
    admin_groups Sequence[str]
    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.
    author_groups Sequence[str]
    Author group associated with your Active Directory.
    aws_account_id str
    AWS account ID hosting the QuickSight account. Default to provider account.
    contact_number str
    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.
    directory_id str
    Active Directory ID that is associated with your Amazon QuickSight account.
    email_address str
    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.
    first_name str
    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.
    iam_identity_center_instance_arn str
    The Amazon Resource Name (ARN) for the IAM Identity Center instance.
    last_name str
    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.
    reader_groups Sequence[str]
    Reader group associated with your Active Direcrtory.
    realm str
    Realm of the Active Directory that is associated with your Amazon QuickSight account.
    accountName String
    Name of your Amazon QuickSight account. This name is unique over all of AWS, and it appears only when users sign in.
    authenticationMethod 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, and ACTIVE_DIRECTORY.
    edition String
    Edition of Amazon QuickSight that you want your account to have. Currently, you can choose from STANDARD, ENTERPRISE or ENTERPRISE_AND_Q.
    notificationEmail String

    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:

    activeDirectoryName String
    Name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
    adminGroups List<String>
    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.
    authorGroups List<String>
    Author group associated with your Active Directory.
    awsAccountId String
    AWS account ID hosting the QuickSight account. Default to provider account.
    contactNumber String
    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 String
    Active Directory ID that is associated with your Amazon QuickSight account.
    emailAddress String
    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 String
    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.
    iamIdentityCenterInstanceArn String
    The Amazon Resource Name (ARN) for the IAM Identity Center instance.
    lastName String
    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.
    readerGroups List<String>
    Reader group associated with your Active Direcrtory.
    realm String
    Realm of the Active Directory that is associated with your Amazon QuickSight account.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AccountSubscription resource produces the following output properties:

    AccountSubscriptionStatus string
    Status of the Amazon QuickSight account's subscription.
    Id string
    The provider-assigned unique ID for this managed resource.
    AccountSubscriptionStatus string
    Status of the Amazon QuickSight account's subscription.
    Id string
    The provider-assigned unique ID for this managed resource.
    accountSubscriptionStatus String
    Status of the Amazon QuickSight account's subscription.
    id String
    The provider-assigned unique ID for this managed resource.
    accountSubscriptionStatus string
    Status of the Amazon QuickSight account's subscription.
    id string
    The provider-assigned unique ID for this managed resource.
    account_subscription_status str
    Status of the Amazon QuickSight account's subscription.
    id str
    The provider-assigned unique ID for this managed resource.
    accountSubscriptionStatus String
    Status of the Amazon QuickSight account's subscription.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AccountSubscription Resource

    Get an existing AccountSubscription resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AccountSubscriptionState, opts?: CustomResourceOptions): AccountSubscription
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_name: Optional[str] = None,
        account_subscription_status: Optional[str] = None,
        active_directory_name: Optional[str] = None,
        admin_groups: Optional[Sequence[str]] = None,
        authentication_method: Optional[str] = None,
        author_groups: Optional[Sequence[str]] = None,
        aws_account_id: Optional[str] = None,
        contact_number: Optional[str] = None,
        directory_id: Optional[str] = None,
        edition: Optional[str] = None,
        email_address: Optional[str] = None,
        first_name: Optional[str] = None,
        iam_identity_center_instance_arn: Optional[str] = None,
        last_name: Optional[str] = None,
        notification_email: Optional[str] = None,
        reader_groups: Optional[Sequence[str]] = None,
        realm: Optional[str] = None) -> AccountSubscription
    func GetAccountSubscription(ctx *Context, name string, id IDInput, state *AccountSubscriptionState, opts ...ResourceOption) (*AccountSubscription, error)
    public static AccountSubscription Get(string name, Input<string> id, AccountSubscriptionState? state, CustomResourceOptions? opts = null)
    public static AccountSubscription get(String name, Output<String> id, AccountSubscriptionState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountName string
    Name of your Amazon QuickSight account. This name is unique over all of AWS, and it appears only when users sign in.
    AccountSubscriptionStatus string
    Status of the Amazon QuickSight account's subscription.
    ActiveDirectoryName string
    Name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
    AdminGroups List<string>
    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 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, and ACTIVE_DIRECTORY.
    AuthorGroups List<string>
    Author group associated with your Active Directory.
    AwsAccountId string
    AWS account ID hosting the QuickSight account. Default to provider account.
    ContactNumber string
    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 string
    Active Directory ID that is associated with your Amazon QuickSight account.
    Edition string
    Edition of Amazon QuickSight that you want your account to have. Currently, you can choose from STANDARD, ENTERPRISE or ENTERPRISE_AND_Q.
    EmailAddress string
    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 string
    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.
    IamIdentityCenterInstanceArn string
    The Amazon Resource Name (ARN) for the IAM Identity Center instance.
    LastName string
    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 string

    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 List<string>
    Reader group associated with your Active Direcrtory.
    Realm string
    Realm of the Active Directory that is associated with your Amazon QuickSight account.
    AccountName string
    Name of your Amazon QuickSight account. This name is unique over all of AWS, and it appears only when users sign in.
    AccountSubscriptionStatus string
    Status of the Amazon QuickSight account's subscription.
    ActiveDirectoryName string
    Name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
    AdminGroups []string
    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 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, and ACTIVE_DIRECTORY.
    AuthorGroups []string
    Author group associated with your Active Directory.
    AwsAccountId string
    AWS account ID hosting the QuickSight account. Default to provider account.
    ContactNumber string
    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 string
    Active Directory ID that is associated with your Amazon QuickSight account.
    Edition string
    Edition of Amazon QuickSight that you want your account to have. Currently, you can choose from STANDARD, ENTERPRISE or ENTERPRISE_AND_Q.
    EmailAddress string
    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 string
    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.
    IamIdentityCenterInstanceArn string
    The Amazon Resource Name (ARN) for the IAM Identity Center instance.
    LastName string
    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 string

    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 []string
    Reader group associated with your Active Direcrtory.
    Realm string
    Realm of the Active Directory that is associated with your Amazon QuickSight account.
    accountName String
    Name of your Amazon QuickSight account. This name is unique over all of AWS, and it appears only when users sign in.
    accountSubscriptionStatus String
    Status of the Amazon QuickSight account's subscription.
    activeDirectoryName String
    Name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
    adminGroups List<String>
    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 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, and ACTIVE_DIRECTORY.
    authorGroups List<String>
    Author group associated with your Active Directory.
    awsAccountId String
    AWS account ID hosting the QuickSight account. Default to provider account.
    contactNumber String
    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 String
    Active Directory ID that is associated with your Amazon QuickSight account.
    edition String
    Edition of Amazon QuickSight that you want your account to have. Currently, you can choose from STANDARD, ENTERPRISE or ENTERPRISE_AND_Q.
    emailAddress String
    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 String
    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.
    iamIdentityCenterInstanceArn String
    The Amazon Resource Name (ARN) for the IAM Identity Center instance.
    lastName String
    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 String

    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 List<String>
    Reader group associated with your Active Direcrtory.
    realm String
    Realm of the Active Directory that is associated with your Amazon QuickSight account.
    accountName string
    Name of your Amazon QuickSight account. This name is unique over all of AWS, and it appears only when users sign in.
    accountSubscriptionStatus string
    Status of the Amazon QuickSight account's subscription.
    activeDirectoryName string
    Name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
    adminGroups string[]
    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 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, and ACTIVE_DIRECTORY.
    authorGroups string[]
    Author group associated with your Active Directory.
    awsAccountId string
    AWS account ID hosting the QuickSight account. Default to provider account.
    contactNumber string
    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 string
    Active Directory ID that is associated with your Amazon QuickSight account.
    edition string
    Edition of Amazon QuickSight that you want your account to have. Currently, you can choose from STANDARD, ENTERPRISE or ENTERPRISE_AND_Q.
    emailAddress string
    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 string
    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.
    iamIdentityCenterInstanceArn string
    The Amazon Resource Name (ARN) for the IAM Identity Center instance.
    lastName string
    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 string

    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 string[]
    Reader group associated with your Active Direcrtory.
    realm string
    Realm of the Active Directory that is associated with your Amazon QuickSight account.
    account_name str
    Name of your Amazon QuickSight account. This name is unique over all of AWS, and it appears only when users sign in.
    account_subscription_status str
    Status of the Amazon QuickSight account's subscription.
    active_directory_name str
    Name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
    admin_groups Sequence[str]
    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.
    authentication_method str
    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.
    author_groups Sequence[str]
    Author group associated with your Active Directory.
    aws_account_id str
    AWS account ID hosting the QuickSight account. Default to provider account.
    contact_number str
    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.
    directory_id str
    Active Directory ID that is associated with your Amazon QuickSight account.
    edition str
    Edition of Amazon QuickSight that you want your account to have. Currently, you can choose from STANDARD, ENTERPRISE or ENTERPRISE_AND_Q.
    email_address str
    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.
    first_name str
    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.
    iam_identity_center_instance_arn str
    The Amazon Resource Name (ARN) for the IAM Identity Center instance.
    last_name str
    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.
    notification_email str

    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:

    reader_groups Sequence[str]
    Reader group associated with your Active Direcrtory.
    realm str
    Realm of the Active Directory that is associated with your Amazon QuickSight account.
    accountName String
    Name of your Amazon QuickSight account. This name is unique over all of AWS, and it appears only when users sign in.
    accountSubscriptionStatus String
    Status of the Amazon QuickSight account's subscription.
    activeDirectoryName String
    Name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
    adminGroups List<String>
    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 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, and ACTIVE_DIRECTORY.
    authorGroups List<String>
    Author group associated with your Active Directory.
    awsAccountId String
    AWS account ID hosting the QuickSight account. Default to provider account.
    contactNumber String
    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 String
    Active Directory ID that is associated with your Amazon QuickSight account.
    edition String
    Edition of Amazon QuickSight that you want your account to have. Currently, you can choose from STANDARD, ENTERPRISE or ENTERPRISE_AND_Q.
    emailAddress String
    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 String
    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.
    iamIdentityCenterInstanceArn String
    The Amazon Resource Name (ARN) for the IAM Identity Center instance.
    lastName String
    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 String

    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 List<String>
    Reader group associated with your Active Direcrtory.
    realm String
    Realm of the Active Directory that is associated with your Amazon QuickSight account.

    Import

    You cannot import this resource.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws