aws.quicksight.AccountSettings
Explore with Pulumi AI
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]))
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 {
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
})
}
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 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.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-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}
Create AccountSettings Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AccountSettings(name: string, args?: AccountSettingsArgs, opts?: CustomResourceOptions);
@overload
def AccountSettings(resource_name: str,
args: Optional[AccountSettingsArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def AccountSettings(resource_name: str,
opts: Optional[ResourceOptions] = None,
aws_account_id: Optional[str] = None,
default_namespace: Optional[str] = None,
termination_protection_enabled: Optional[bool] = None,
timeouts: Optional[AccountSettingsTimeoutsArgs] = None)
func NewAccountSettings(ctx *Context, name string, args *AccountSettingsArgs, opts ...ResourceOption) (*AccountSettings, error)
public AccountSettings(string name, AccountSettingsArgs? args = null, CustomResourceOptions? opts = null)
public AccountSettings(String name, AccountSettingsArgs args)
public AccountSettings(String name, AccountSettingsArgs args, CustomResourceOptions options)
type: aws:quicksight:AccountSettings
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 AccountSettingsArgs
- 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 AccountSettingsArgs
- 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 AccountSettingsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AccountSettingsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AccountSettingsArgs
- 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 accountSettingsResource = new Aws.Quicksight.AccountSettings("accountSettingsResource", new()
{
AwsAccountId = "string",
DefaultNamespace = "string",
TerminationProtectionEnabled = false,
Timeouts = new Aws.Quicksight.Inputs.AccountSettingsTimeoutsArgs
{
Create = "string",
Update = "string",
},
});
example, err := quicksight.NewAccountSettings(ctx, "accountSettingsResource", &quicksight.AccountSettingsArgs{
AwsAccountId: pulumi.String("string"),
DefaultNamespace: pulumi.String("string"),
TerminationProtectionEnabled: pulumi.Bool(false),
Timeouts: &quicksight.AccountSettingsTimeoutsArgs{
Create: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
var accountSettingsResource = new AccountSettings("accountSettingsResource", AccountSettingsArgs.builder()
.awsAccountId("string")
.defaultNamespace("string")
.terminationProtectionEnabled(false)
.timeouts(AccountSettingsTimeoutsArgs.builder()
.create("string")
.update("string")
.build())
.build());
account_settings_resource = aws.quicksight.AccountSettings("accountSettingsResource",
aws_account_id="string",
default_namespace="string",
termination_protection_enabled=False,
timeouts={
"create": "string",
"update": "string",
})
const accountSettingsResource = new aws.quicksight.AccountSettings("accountSettingsResource", {
awsAccountId: "string",
defaultNamespace: "string",
terminationProtectionEnabled: false,
timeouts: {
create: "string",
update: "string",
},
});
type: aws:quicksight:AccountSettings
properties:
awsAccountId: string
defaultNamespace: string
terminationProtectionEnabled: false
timeouts:
create: string
update: string
AccountSettings 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 AccountSettings resource accepts the following input properties:
- Aws
Account stringId - The ID for the AWS account that contains the settings.
- Default
Namespace string - The default namespace for this Amazon Web Services account. Currently, the default is
default
. - Termination
Protection boolEnabled - 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. Iffalse
, it will allow the account to be deleted. - Timeouts
Account
Settings Timeouts
- Aws
Account stringId - The ID for the AWS account that contains the settings.
- Default
Namespace string - The default namespace for this Amazon Web Services account. Currently, the default is
default
. - Termination
Protection boolEnabled - 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. Iffalse
, it will allow the account to be deleted. - Timeouts
Account
Settings Timeouts Args
- aws
Account StringId - The ID for the AWS account that contains the settings.
- default
Namespace String - The default namespace for this Amazon Web Services account. Currently, the default is
default
. - termination
Protection BooleanEnabled - 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. Iffalse
, it will allow the account to be deleted. - timeouts
Account
Settings Timeouts
- aws
Account stringId - The ID for the AWS account that contains the settings.
- default
Namespace string - The default namespace for this Amazon Web Services account. Currently, the default is
default
. - termination
Protection booleanEnabled - 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. Iffalse
, it will allow the account to be deleted. - timeouts
Account
Settings Timeouts
- aws_
account_ strid - The ID for the AWS account that contains the settings.
- default_
namespace str - The default namespace for this Amazon Web Services account. Currently, the default is
default
. - termination_
protection_ boolenabled - 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. Iffalse
, it will allow the account to be deleted. - timeouts
Account
Settings Timeouts Args
- aws
Account StringId - The ID for the AWS account that contains the settings.
- default
Namespace String - The default namespace for this Amazon Web Services account. Currently, the default is
default
. - termination
Protection BooleanEnabled - 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. Iffalse
, it will allow the account to be deleted. - timeouts Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the AccountSettings resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing AccountSettings Resource
Get an existing AccountSettings 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?: AccountSettingsState, opts?: CustomResourceOptions): AccountSettings
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
aws_account_id: Optional[str] = None,
default_namespace: Optional[str] = None,
termination_protection_enabled: Optional[bool] = None,
timeouts: Optional[AccountSettingsTimeoutsArgs] = None) -> AccountSettings
func GetAccountSettings(ctx *Context, name string, id IDInput, state *AccountSettingsState, opts ...ResourceOption) (*AccountSettings, error)
public static AccountSettings Get(string name, Input<string> id, AccountSettingsState? state, CustomResourceOptions? opts = null)
public static AccountSettings get(String name, Output<String> id, AccountSettingsState state, CustomResourceOptions options)
resources: _: type: aws:quicksight:AccountSettings get: id: ${id}
- 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.
- Aws
Account stringId - The ID for the AWS account that contains the settings.
- Default
Namespace string - The default namespace for this Amazon Web Services account. Currently, the default is
default
. - Termination
Protection boolEnabled - 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. Iffalse
, it will allow the account to be deleted. - Timeouts
Account
Settings Timeouts
- Aws
Account stringId - The ID for the AWS account that contains the settings.
- Default
Namespace string - The default namespace for this Amazon Web Services account. Currently, the default is
default
. - Termination
Protection boolEnabled - 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. Iffalse
, it will allow the account to be deleted. - Timeouts
Account
Settings Timeouts Args
- aws
Account StringId - The ID for the AWS account that contains the settings.
- default
Namespace String - The default namespace for this Amazon Web Services account. Currently, the default is
default
. - termination
Protection BooleanEnabled - 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. Iffalse
, it will allow the account to be deleted. - timeouts
Account
Settings Timeouts
- aws
Account stringId - The ID for the AWS account that contains the settings.
- default
Namespace string - The default namespace for this Amazon Web Services account. Currently, the default is
default
. - termination
Protection booleanEnabled - 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. Iffalse
, it will allow the account to be deleted. - timeouts
Account
Settings Timeouts
- aws_
account_ strid - The ID for the AWS account that contains the settings.
- default_
namespace str - The default namespace for this Amazon Web Services account. Currently, the default is
default
. - termination_
protection_ boolenabled - 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. Iffalse
, it will allow the account to be deleted. - timeouts
Account
Settings Timeouts Args
- aws
Account StringId - The ID for the AWS account that contains the settings.
- default
Namespace String - The default namespace for this Amazon Web Services account. Currently, the default is
default
. - termination
Protection BooleanEnabled - 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. Iffalse
, it will allow the account to be deleted. - timeouts Property Map
Supporting Types
AccountSettingsTimeouts, AccountSettingsTimeoutsArgs
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- update String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- update string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- update str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- update String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
Import
Using pulumi import
, import QuickSight Account Settings using the AWS account ID. For example:
$ pulumi import aws:quicksight/accountSettings:AccountSettings example "012345678901"
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.