aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
95 lines (94 loc) • 4.21 kB
TypeScript
import * as cdk from "../../core/lib";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
import { AccountCustomizationReference, IAccountCustomizationRef } from "../../interfaces/generated/aws-uxc-interfaces.generated";
/**
* Resource schema for managing AWS account-level UX customization settings, including account color, visible services, and visible regions.
*
* @cloudformationResource AWS::UXC::AccountCustomization
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-uxc-accountcustomization.html
*/
export declare class CfnAccountCustomization extends cdk.CfnResource implements cdk.IInspectable, IAccountCustomizationRef {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnAccountCustomization from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnAccountCustomization;
/**
* Checks whether the given object is a CfnAccountCustomization
*/
static isCfnAccountCustomization(x: any): x is CfnAccountCustomization;
/**
* The color theme assigned to the account for visual identification in the AWS Console.
*/
accountColor?: string;
/**
* A list of AWS region identifiers visible to the account in the AWS Console.
*/
visibleRegions?: Array<string>;
/**
* A list of AWS service identifiers visible to the account in the AWS Console.
*/
visibleServices?: Array<string>;
/**
* Create a new `AWS::UXC::AccountCustomization`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props?: CfnAccountCustomizationProps);
get accountCustomizationRef(): AccountCustomizationReference;
/**
* The AWS account ID that this customization belongs to. This is automatically determined from the caller's identity.
*
* @cloudformationAttribute AccountId
*/
get attrAccountId(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
/**
* Properties for defining a `CfnAccountCustomization`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-uxc-accountcustomization.html
*/
export interface CfnAccountCustomizationProps {
/**
* The color theme assigned to the account for visual identification in the AWS Console.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-uxc-accountcustomization.html#cfn-uxc-accountcustomization-accountcolor
*/
readonly accountColor?: string;
/**
* A list of AWS region identifiers visible to the account in the AWS Console.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-uxc-accountcustomization.html#cfn-uxc-accountcustomization-visibleregions
*/
readonly visibleRegions?: Array<string>;
/**
* A list of AWS service identifiers visible to the account in the AWS Console.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-uxc-accountcustomization.html#cfn-uxc-accountcustomization-visibleservices
*/
readonly visibleServices?: Array<string>;
}
export type { IAccountCustomizationRef, AccountCustomizationReference };