AccountSettings class

Resource for managing an AWS QuickSight Account Settings.

> Deletion of this resource will not modify any settings, only remove the resource from state.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const subscription = new aws.quicksight.AccountSubscription("subscription", {
    accountName: "quicksight-terraform",
    authenticationMethod: "IAM_AND_QUICKSIGHT",
    edition: "ENTERPRISE",
    notificationEmail: "notification@email.com",
});
const example = new aws.quicksight.AccountSettings("example", {terminationProtectionEnabled: false}, {
    dependsOn: [subscription],
});
import pulumi
import pulumi_aws as aws

subscription = aws.quicksight.AccountSubscription("subscription",
    account_name="quicksight-terraform",
    authentication_method="IAM_AND_QUICKSIGHT",
    edition="ENTERPRISE",
    notification_email="notification@email.com")
example = aws.quicksight.AccountSettings("example", termination_protection_enabled=False,
opts = pulumi.ResourceOptions(depends_on=[subscription]))
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-terraform",
        AuthenticationMethod = "IAM_AND_QUICKSIGHT",
        Edition = "ENTERPRISE",
        NotificationEmail = "notification@email.com",
    });

    var example = new Aws.Quicksight.AccountSettings("example", new()
    {
        TerminationProtectionEnabled = false,
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            subscription,
        },
    });

});
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 {
		subscription, err := quicksight.NewAccountSubscription(ctx, "subscription", &quicksight.AccountSubscriptionArgs{
			AccountName:          pulumi.String("quicksight-terraform"),
			AuthenticationMethod: pulumi.String("IAM_AND_QUICKSIGHT"),
			Edition:              pulumi.String("ENTERPRISE"),
			NotificationEmail:    pulumi.String("notification@email.com"),
		})
		if err != nil {
			return err
		}
		_, err = quicksight.NewAccountSettings(ctx, "example", &quicksight.AccountSettingsArgs{
			TerminationProtectionEnabled: pulumi.Bool(false),
		}, pulumi.DependsOn([]pulumi.Resource{
			subscription,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_quicksight_accountsubscription" "subscription" {
  account_name          = "quicksight-terraform"
  authentication_method = "IAM_AND_QUICKSIGHT"
  edition               = "ENTERPRISE"
  notification_email    = "notification@email.com"
}
resource "aws_quicksight_accountsettings" "example" {
  depends_on                     = [aws_quicksight_accountsubscription.subscription]
  termination_protection_enabled = false
}
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 com.pulumi.aws.quicksight.AccountSettings;
import com.pulumi.aws.quicksight.AccountSettingsArgs;
import com.pulumi.resources.CustomResourceOptions;
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-terraform")
            .authenticationMethod("IAM_AND_QUICKSIGHT")
            .edition("ENTERPRISE")
            .notificationEmail("notification@email.com")
            .build());

        var example = new AccountSettings("example", AccountSettingsArgs.builder()
            .terminationProtectionEnabled(false)
            .build(), CustomResourceOptions.builder()
                .dependsOn(subscription)
                .build());

    }
}
resources:
  subscription:
    type: aws:quicksight:AccountSubscription
    properties:
      accountName: quicksight-terraform
      authenticationMethod: IAM_AND_QUICKSIGHT
      edition: ENTERPRISE
      notificationEmail: notification@email.com
  example:
    type: aws:quicksight:AccountSettings
    properties:
      terminationProtectionEnabled: false
    options:
      dependsOn:
        - ${subscription}

Import

Using pulumi import, import QuickSight Account Settings using the AWS account ID. For example:

$ pulumi import aws:quicksight/accountSettings:AccountSettings example "012345678901"

Constructors

AccountSettings(String name, {AccountSettingsArgs? args, CustomResourceOptions? options})
Creates a new AccountSettings. name The Pulumi resource name. args Arguments used to configure this AccountSettings. The set of arguments for AccountSettings. options Resource options controlling this resource's behavior.
AccountSettings.reference(String urn)
Creates a typed reference to an existing AccountSettings resource.

Properties

awsAccountId ↔ Output<String>
AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
defaultNamespace ↔ Output<String>
The default namespace for this Amazon Web Services account. Currently, the default is default.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
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
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
terminationProtectionEnabled ↔ Output<bool>
A boolean value that determines whether or not an Amazon QuickSight account can be deleted. If true, it does not allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription request. If false, it will allow the account to be deleted.
latefinal
timeouts ↔ Output<AccountSettingsTimeouts?>
latefinal
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, {AccountSettingsState? state, CustomResourceOptions? options}) → AccountSettings
Gets an existing AccountSettings resource's state with the given name and id.