AccountCustomizations class

Manages UXC Account Customizations for an AWS Account. This resource controls the console experience for the account, including the account color and which AWS regions and services are visible in the AWS Management Console.

> Note: There is only a single set of account customizations per AWS account.

> Note: This resource operates globally and always targets the us-east-1 region regardless of the provider region configuration.

> Note: The UXC API does not provide a delete operation. Destroying this resource resets all customizations to their defaults: accountColor is set to none, and both visibleRegions and visibleServices are cleared to allow all regions and services.

Example Usage

Set Account Color

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

const example = new aws.uxc.AccountCustomizations("example", {accountColor: "lightBlue"});
import pulumi
import pulumi_aws as aws

example = aws.uxc.AccountCustomizations("example", account_color="lightBlue")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Uxc.AccountCustomizations("example", new()
    {
        AccountColor = "lightBlue",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/uxc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := uxc.NewAccountCustomizations(ctx, "example", &uxc.AccountCustomizationsArgs{
			AccountColor: pulumi.String("lightBlue"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_uxc_accountcustomizations" "example" {
  account_color = "lightBlue"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.uxc.AccountCustomizations;
import com.pulumi.aws.uxc.AccountCustomizationsArgs;
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 example = new AccountCustomizations("example", AccountCustomizationsArgs.builder()
            .accountColor("lightBlue")
            .build());

    }
}
resources:
  example:
    type: aws:uxc:AccountCustomizations
    properties:
      accountColor: lightBlue

Restrict Visible Regions and Services

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

const example = new aws.uxc.AccountCustomizations("example", {
    accountColor: "green",
    visibleRegions: [
        "us-east-1",
        "us-west-2",
        "eu-west-1",
    ],
    visibleServices: [
        "ec2",
        "s3",
        "rds",
    ],
});
import pulumi
import pulumi_aws as aws

example = aws.uxc.AccountCustomizations("example",
    account_color="green",
    visible_regions=[
        "us-east-1",
        "us-west-2",
        "eu-west-1",
    ],
    visible_services=[
        "ec2",
        "s3",
        "rds",
    ])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Uxc.AccountCustomizations("example", new()
    {
        AccountColor = "green",
        VisibleRegions = new[]
        {
            "us-east-1",
            "us-west-2",
            "eu-west-1",
        },
        VisibleServices = new[]
        {
            "ec2",
            "s3",
            "rds",
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/uxc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := uxc.NewAccountCustomizations(ctx, "example", &uxc.AccountCustomizationsArgs{
			AccountColor: pulumi.String("green"),
			VisibleRegions: pulumi.StringArray{
				pulumi.String("us-east-1"),
				pulumi.String("us-west-2"),
				pulumi.String("eu-west-1"),
			},
			VisibleServices: pulumi.StringArray{
				pulumi.String("ec2"),
				pulumi.String("s3"),
				pulumi.String("rds"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_uxc_accountcustomizations" "example" {
  account_color    = "green"
  visible_regions  = ["us-east-1", "us-west-2", "eu-west-1"]
  visible_services = ["ec2", "s3", "rds"]
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.uxc.AccountCustomizations;
import com.pulumi.aws.uxc.AccountCustomizationsArgs;
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 example = new AccountCustomizations("example", AccountCustomizationsArgs.builder()
            .accountColor("green")
            .visibleRegions(
                "us-east-1",
                "us-west-2",
                "eu-west-1")
            .visibleServices(
                "ec2",
                "s3",
                "rds")
            .build());

    }
}
resources:
  example:
    type: aws:uxc:AccountCustomizations
    properties:
      accountColor: green
      visibleRegions:
        - us-east-1
        - us-west-2
        - eu-west-1
      visibleServices:
        - ec2
        - s3
        - rds

Import

Identity Schema

Optional

  • accountId (String) Account ID where this resource is managed.

Using pulumi import, import UXC Account Customizations using the AWS account ID. For example:

$ pulumi import aws:uxc/accountCustomizations:AccountCustomizations example 123456789012

Constructors

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

Properties

accountColor ↔ Output<String>
Color used to identify the account in the AWS Management Console. Valid values are none, red, darkBlue, lightBlue, green, yellow, orange, pink, purple, and teal. Defaults to none.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
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
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
visibleRegions ↔ Output<List<String>>
Set of AWS region codes to display in the console. When omitted or empty, all regions are visible.
latefinal
visibleServices ↔ Output<List<String>>
Set of AWS service identifiers to display in the console. When omitted or empty, all services are visible.
latefinal

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, {AccountCustomizationsState? state, CustomResourceOptions? options}) → AccountCustomizations
Gets an existing AccountCustomizations resource's state with the given name and id.