aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
176 lines (175 loc) • 6.81 kB
TypeScript
import * as cdk from "../../core/lib";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
import { IWorkspaceRef, WorkspaceReference } from "../../interfaces/generated/aws-awsexternalanthropic-interfaces.generated";
/**
* Resource type definition for AWS::AWSExternalAnthropic::Workspace.
*
* @cloudformationResource AWS::AWSExternalAnthropic::Workspace
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-awsexternalanthropic-workspace.html
*/
export declare class CfnWorkspace extends cdk.CfnResource implements cdk.IInspectable, IWorkspaceRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnWorkspace 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): CfnWorkspace;
/**
* Checks whether the given object is a CfnWorkspace
*/
static isCfnWorkspace(x: any): x is CfnWorkspace;
static arnForWorkspace(resource: IWorkspaceRef): string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* Data residency configuration for the workspace.
*/
private _dataResidency?;
/**
* The name of the workspace.
*/
private _name;
/**
* An array of key-value pairs to apply to this resource.
*/
private _tags?;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::AWSExternalAnthropic::Workspace`.
*
* @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: CfnWorkspaceProps);
get workspaceRef(): WorkspaceReference;
/**
* Data residency configuration for the workspace.
*/
get dataResidency(): CfnWorkspace.DataResidencyProperty | cdk.IResolvable | undefined;
/**
* Data residency configuration for the workspace.
*/
set dataResidency(value: CfnWorkspace.DataResidencyProperty | cdk.IResolvable | undefined);
/**
* The name of the workspace.
*/
get name(): string;
/**
* The name of the workspace.
*/
set name(value: string);
/**
* An array of key-value pairs to apply to this resource.
*/
get tags(): Array<cdk.CfnTag> | undefined;
/**
* An array of key-value pairs to apply to this resource.
*/
set tags(value: Array<cdk.CfnTag> | undefined);
/**
* The ARN of the workspace.
*
* @cloudformationAttribute Arn
*/
get attrArn(): string;
/**
* The timestamp when the workspace was created.
*
* @cloudformationAttribute CreatedAt
*/
get attrCreatedAt(): string;
/**
* The unique identifier of the workspace.
*
* @cloudformationAttribute Id
*/
get attrId(): 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>;
}
export declare namespace CfnWorkspace {
/**
* Data residency configuration for the workspace.
*
* WorkspaceGeo is immutable after creation.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-awsexternalanthropic-workspace-dataresidency.html
*/
interface DataResidencyProperty {
/**
* Permitted inference geo values.
*
* Omit to allow all geos (the service default of 'unrestricted'); otherwise list specific geos.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-awsexternalanthropic-workspace-dataresidency.html#cfn-awsexternalanthropic-workspace-dataresidency-allowedinferencegeos
*/
readonly allowedInferenceGeos?: Array<string>;
/**
* Default inference geo applied when requests omit the parameter.
*
* Defaults to 'global' if omitted. Must be a member of AllowedInferenceGeos unless AllowedInferenceGeos is omitted.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-awsexternalanthropic-workspace-dataresidency.html#cfn-awsexternalanthropic-workspace-dataresidency-defaultinferencegeo
*/
readonly defaultInferenceGeo?: string;
/**
* Geographic region for workspace data storage.
*
* Immutable after creation. Defaults to 'us' if omitted.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-awsexternalanthropic-workspace-dataresidency.html#cfn-awsexternalanthropic-workspace-dataresidency-workspacegeo
*/
readonly workspaceGeo?: string;
}
}
/**
* Properties for defining a `CfnWorkspace`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-awsexternalanthropic-workspace.html
*/
export interface CfnWorkspaceProps {
/**
* Data residency configuration for the workspace.
*
* WorkspaceGeo is immutable after creation.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-awsexternalanthropic-workspace.html#cfn-awsexternalanthropic-workspace-dataresidency
*/
readonly dataResidency?: CfnWorkspace.DataResidencyProperty | cdk.IResolvable;
/**
* The name of the workspace.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-awsexternalanthropic-workspace.html#cfn-awsexternalanthropic-workspace-name
*/
readonly name: string;
/**
* An array of key-value pairs to apply to this resource.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-awsexternalanthropic-workspace.html#cfn-awsexternalanthropic-workspace-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
export type { IWorkspaceRef, WorkspaceReference };