aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
1,207 lines • 106 kB
TypeScript
import * as cdk from "../../core";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
/**
* This resource creates an app block.
*
* App blocks store details about the virtual hard disk that contains the files for the application in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. App blocks are only supported for Elastic fleets.
*
* @cloudformationResource AWS::AppStream::AppBlock
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html
*/
export declare class CfnAppBlock extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnAppBlock 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): CfnAppBlock;
/**
* The ARN of the app block.
*
* @cloudformationAttribute Arn
*/
readonly attrArn: string;
/**
* The time when the app block was created.
*
* @cloudformationAttribute CreatedTime
*/
readonly attrCreatedTime: string;
/**
* The description of the app block.
*/
description?: string;
/**
* The display name of the app block.
*/
displayName?: string;
/**
* The name of the app block.
*/
name: string;
/**
* The packaging type of the app block.
*/
packagingType?: string;
/**
* The post setup script details of the app block.
*/
postSetupScriptDetails?: cdk.IResolvable | CfnAppBlock.ScriptDetailsProperty;
/**
* The setup script details of the app block.
*/
setupScriptDetails?: cdk.IResolvable | CfnAppBlock.ScriptDetailsProperty;
/**
* The source S3 location of the app block.
*/
sourceS3Location: cdk.IResolvable | CfnAppBlock.S3LocationProperty;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* The tags of the app block.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* @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: CfnAppBlockProps);
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 CfnAppBlock {
/**
* The details of the script.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-scriptdetails.html
*/
interface ScriptDetailsProperty {
/**
* The parameters used in the run path for the script.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-scriptdetails.html#cfn-appstream-appblock-scriptdetails-executableparameters
*/
readonly executableParameters?: string;
/**
* The run path for the script.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-scriptdetails.html#cfn-appstream-appblock-scriptdetails-executablepath
*/
readonly executablePath: string;
/**
* The S3 object location of the script.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-scriptdetails.html#cfn-appstream-appblock-scriptdetails-scripts3location
*/
readonly scriptS3Location: cdk.IResolvable | CfnAppBlock.S3LocationProperty;
/**
* The run timeout, in seconds, for the script.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-scriptdetails.html#cfn-appstream-appblock-scriptdetails-timeoutinseconds
*/
readonly timeoutInSeconds: number;
}
/**
* The S3 location of the app block.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-s3location.html
*/
interface S3LocationProperty {
/**
* The S3 bucket of the app block.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-s3location.html#cfn-appstream-appblock-s3location-s3bucket
*/
readonly s3Bucket: string;
/**
* The S3 key of the S3 object of the virtual hard disk.
*
* This is required when it's used by `SetupScriptDetails` and `PostSetupScriptDetails` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblock-s3location.html#cfn-appstream-appblock-s3location-s3key
*/
readonly s3Key?: string;
}
}
/**
* Properties for defining a `CfnAppBlock`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html
*/
export interface CfnAppBlockProps {
/**
* The description of the app block.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html#cfn-appstream-appblock-description
*/
readonly description?: string;
/**
* The display name of the app block.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html#cfn-appstream-appblock-displayname
*/
readonly displayName?: string;
/**
* The name of the app block.
*
* *Pattern* : `^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html#cfn-appstream-appblock-name
*/
readonly name: string;
/**
* The packaging type of the app block.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html#cfn-appstream-appblock-packagingtype
*/
readonly packagingType?: string;
/**
* The post setup script details of the app block.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html#cfn-appstream-appblock-postsetupscriptdetails
*/
readonly postSetupScriptDetails?: cdk.IResolvable | CfnAppBlock.ScriptDetailsProperty;
/**
* The setup script details of the app block.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html#cfn-appstream-appblock-setupscriptdetails
*/
readonly setupScriptDetails?: cdk.IResolvable | CfnAppBlock.ScriptDetailsProperty;
/**
* The source S3 location of the app block.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html#cfn-appstream-appblock-sources3location
*/
readonly sourceS3Location: cdk.IResolvable | CfnAppBlock.S3LocationProperty;
/**
* The tags of the app block.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblock.html#cfn-appstream-appblock-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* Creates an app block builder.
*
* @cloudformationResource AWS::AppStream::AppBlockBuilder
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html
*/
export declare class CfnAppBlockBuilder extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnAppBlockBuilder 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): CfnAppBlockBuilder;
/**
* The ARN of the app block builder.
*
* @cloudformationAttribute Arn
*/
readonly attrArn: string;
/**
* The time when the app block builder was created.
*
* @cloudformationAttribute CreatedTime
*/
readonly attrCreatedTime: string;
/**
* The access endpoints of the app block builder.
*/
accessEndpoints?: Array<CfnAppBlockBuilder.AccessEndpointProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The ARN of the app block.
*/
appBlockArns?: Array<string>;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* The description of the app block builder.
*/
description?: string;
/**
* The display name of the app block builder.
*/
displayName?: string;
/**
* Indicates whether default internet access is enabled for the app block builder.
*/
enableDefaultInternetAccess?: boolean | cdk.IResolvable;
/**
* The ARN of the IAM role that is applied to the app block builder.
*/
iamRoleArn?: string;
/**
* The instance type of the app block builder.
*/
instanceType: string;
/**
* The name of the app block builder.
*/
name: string;
/**
* The platform of the app block builder.
*/
platform: string;
/**
* The tags of the app block builder.
*/
tags?: Array<cdk.CfnTag>;
/**
* The VPC configuration for the app block builder.
*/
vpcConfig: cdk.IResolvable | CfnAppBlockBuilder.VpcConfigProperty;
/**
* @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: CfnAppBlockBuilderProps);
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 CfnAppBlockBuilder {
/**
* Describes VPC configuration information for fleets and image builders.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblockbuilder-vpcconfig.html
*/
interface VpcConfigProperty {
/**
* The identifiers of the security groups for the fleet or image builder.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblockbuilder-vpcconfig.html#cfn-appstream-appblockbuilder-vpcconfig-securitygroupids
*/
readonly securityGroupIds?: Array<string>;
/**
* The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance.
*
* Fleet instances use one or more subnets. Image builder instances use one subnet.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblockbuilder-vpcconfig.html#cfn-appstream-appblockbuilder-vpcconfig-subnetids
*/
readonly subnetIds?: Array<string>;
}
/**
* Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblockbuilder-accessendpoint.html
*/
interface AccessEndpointProperty {
/**
* The type of interface endpoint.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblockbuilder-accessendpoint.html#cfn-appstream-appblockbuilder-accessendpoint-endpointtype
*/
readonly endpointType: string;
/**
* The identifier (ID) of the VPC in which the interface endpoint is used.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-appblockbuilder-accessendpoint.html#cfn-appstream-appblockbuilder-accessendpoint-vpceid
*/
readonly vpceId: string;
}
}
/**
* Properties for defining a `CfnAppBlockBuilder`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html
*/
export interface CfnAppBlockBuilderProps {
/**
* The access endpoints of the app block builder.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#cfn-appstream-appblockbuilder-accessendpoints
*/
readonly accessEndpoints?: Array<CfnAppBlockBuilder.AccessEndpointProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The ARN of the app block.
*
* *Maximum* : `1`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#cfn-appstream-appblockbuilder-appblockarns
*/
readonly appBlockArns?: Array<string>;
/**
* The description of the app block builder.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#cfn-appstream-appblockbuilder-description
*/
readonly description?: string;
/**
* The display name of the app block builder.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#cfn-appstream-appblockbuilder-displayname
*/
readonly displayName?: string;
/**
* Indicates whether default internet access is enabled for the app block builder.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#cfn-appstream-appblockbuilder-enabledefaultinternetaccess
*/
readonly enableDefaultInternetAccess?: boolean | cdk.IResolvable;
/**
* The ARN of the IAM role that is applied to the app block builder.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#cfn-appstream-appblockbuilder-iamrolearn
*/
readonly iamRoleArn?: string;
/**
* The instance type of the app block builder.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#cfn-appstream-appblockbuilder-instancetype
*/
readonly instanceType: string;
/**
* The name of the app block builder.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#cfn-appstream-appblockbuilder-name
*/
readonly name: string;
/**
* The platform of the app block builder.
*
* *Allowed values* : `WINDOWS_SERVER_2019`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#cfn-appstream-appblockbuilder-platform
*/
readonly platform: string;
/**
* The tags of the app block builder.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#cfn-appstream-appblockbuilder-tags
*/
readonly tags?: Array<cdk.CfnTag>;
/**
* The VPC configuration for the app block builder.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-appblockbuilder.html#cfn-appstream-appblockbuilder-vpcconfig
*/
readonly vpcConfig: cdk.IResolvable | CfnAppBlockBuilder.VpcConfigProperty;
}
/**
* This resource creates an application.
*
* Applications store the details about how to launch applications on streaming instances. This is only supported for Elastic fleets.
*
* @cloudformationResource AWS::AppStream::Application
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html
*/
export declare class CfnApplication extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnApplication 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): CfnApplication;
/**
* The ARN of the application.
*
* @cloudformationAttribute Arn
*/
readonly attrArn: string;
/**
* The time when the application was created.
*
* @cloudformationAttribute CreatedTime
*/
readonly attrCreatedTime: string;
/**
* The app block ARN with which the application should be associated.
*/
appBlockArn: string;
/**
* A list of attributes to delete from an application.
*/
attributesToDelete?: Array<string>;
/**
* The description of the application.
*/
description?: string;
/**
* The display name of the application.
*/
displayName?: string;
/**
* The icon S3 location of the application.
*/
iconS3Location: cdk.IResolvable | CfnApplication.S3LocationProperty;
/**
* The instance families the application supports.
*/
instanceFamilies: Array<string>;
/**
* The launch parameters of the application.
*/
launchParameters?: string;
/**
* The launch path of the application.
*/
launchPath: string;
/**
* The name of the application.
*/
name: string;
/**
* The platforms the application supports.
*/
platforms: Array<string>;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* The tags of the application.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* The working directory of the application.
*/
workingDirectory?: string;
/**
* @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: CfnApplicationProps);
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 CfnApplication {
/**
* The S3 location of the application icon.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-application-s3location.html
*/
interface S3LocationProperty {
/**
* The S3 bucket of the S3 object.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-application-s3location.html#cfn-appstream-application-s3location-s3bucket
*/
readonly s3Bucket: string;
/**
* The S3 key of the S3 object.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-application-s3location.html#cfn-appstream-application-s3location-s3key
*/
readonly s3Key: string;
}
}
/**
* Properties for defining a `CfnApplication`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html
*/
export interface CfnApplicationProps {
/**
* The app block ARN with which the application should be associated.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-appblockarn
*/
readonly appBlockArn: string;
/**
* A list of attributes to delete from an application.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-attributestodelete
*/
readonly attributesToDelete?: Array<string>;
/**
* The description of the application.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-description
*/
readonly description?: string;
/**
* The display name of the application.
*
* This name is visible to users in the application catalog.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-displayname
*/
readonly displayName?: string;
/**
* The icon S3 location of the application.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-icons3location
*/
readonly iconS3Location: cdk.IResolvable | CfnApplication.S3LocationProperty;
/**
* The instance families the application supports.
*
* *Allowed Values* : `GENERAL_PURPOSE` | `GRAPHICS_G4`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-instancefamilies
*/
readonly instanceFamilies: Array<string>;
/**
* The launch parameters of the application.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-launchparameters
*/
readonly launchParameters?: string;
/**
* The launch path of the application.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-launchpath
*/
readonly launchPath: string;
/**
* The name of the application.
*
* This name is visible to users when a name is not specified in the DisplayName property.
*
* *Pattern* : `^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-name
*/
readonly name: string;
/**
* The platforms the application supports.
*
* *Allowed Values* : `WINDOWS_SERVER_2019` | `AMAZON_LINUX2`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-platforms
*/
readonly platforms: Array<string>;
/**
* The tags of the application.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-tags
*/
readonly tags?: Array<cdk.CfnTag>;
/**
* The working directory of the application.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-application.html#cfn-appstream-application-workingdirectory
*/
readonly workingDirectory?: string;
}
/**
* Associates an application to an entitlement.
*
* @cloudformationResource AWS::AppStream::ApplicationEntitlementAssociation
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-applicationentitlementassociation.html
*/
export declare class CfnApplicationEntitlementAssociation extends cdk.CfnResource implements cdk.IInspectable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnApplicationEntitlementAssociation 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): CfnApplicationEntitlementAssociation;
/**
* The identifier of the application.
*/
applicationIdentifier: string;
/**
* The name of the entitlement.
*/
entitlementName: string;
/**
* The name of the stack.
*/
stackName: string;
/**
* @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: CfnApplicationEntitlementAssociationProps);
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 `CfnApplicationEntitlementAssociation`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-applicationentitlementassociation.html
*/
export interface CfnApplicationEntitlementAssociationProps {
/**
* The identifier of the application.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-applicationentitlementassociation.html#cfn-appstream-applicationentitlementassociation-applicationidentifier
*/
readonly applicationIdentifier: string;
/**
* The name of the entitlement.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-applicationentitlementassociation.html#cfn-appstream-applicationentitlementassociation-entitlementname
*/
readonly entitlementName: string;
/**
* The name of the stack.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-applicationentitlementassociation.html#cfn-appstream-applicationentitlementassociation-stackname
*/
readonly stackName: string;
}
/**
* This resource associates the specified application with the specified fleet.
*
* This is only supported for Elastic fleets.
*
* @cloudformationResource AWS::AppStream::ApplicationFleetAssociation
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-applicationfleetassociation.html
*/
export declare class CfnApplicationFleetAssociation extends cdk.CfnResource implements cdk.IInspectable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnApplicationFleetAssociation 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): CfnApplicationFleetAssociation;
/**
* The ARN of the application.
*/
applicationArn: string;
/**
* The name of the fleet.
*/
fleetName: string;
/**
* @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: CfnApplicationFleetAssociationProps);
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 `CfnApplicationFleetAssociation`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-applicationfleetassociation.html
*/
export interface CfnApplicationFleetAssociationProps {
/**
* The ARN of the application.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-applicationfleetassociation.html#cfn-appstream-applicationfleetassociation-applicationarn
*/
readonly applicationArn: string;
/**
* The name of the fleet.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-applicationfleetassociation.html#cfn-appstream-applicationfleetassociation-fleetname
*/
readonly fleetName: string;
}
/**
* The `AWS::AppStream::DirectoryConfig` resource specifies the configuration information required to join Amazon AppStream 2.0 fleets and image builders to Microsoft Active Directory domains.
*
* @cloudformationResource AWS::AppStream::DirectoryConfig
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-directoryconfig.html
*/
export declare class CfnDirectoryConfig extends cdk.CfnResource implements cdk.IInspectable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnDirectoryConfig 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): CfnDirectoryConfig;
/**
* The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.
*/
certificateBasedAuthProperties?: CfnDirectoryConfig.CertificateBasedAuthPropertiesProperty | cdk.IResolvable;
/**
* The fully qualified name of the directory (for example, corp.example.com).
*/
directoryName: string;
/**
* The distinguished names of the organizational units for computer accounts.
*/
organizationalUnitDistinguishedNames: Array<string>;
/**
* The credentials for the service account used by the streaming instance to connect to the directory.
*/
serviceAccountCredentials: cdk.IResolvable | CfnDirectoryConfig.ServiceAccountCredentialsProperty;
/**
* @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: CfnDirectoryConfigProps);
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 CfnDirectoryConfig {
/**
* The credentials for the service account used by the streaming instance to connect to the directory.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-serviceaccountcredentials.html
*/
interface ServiceAccountCredentialsProperty {
/**
* The user name of the account.
*
* This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-serviceaccountcredentials.html#cfn-appstream-directoryconfig-serviceaccountcredentials-accountname
*/
readonly accountName: string;
/**
* The password for the account.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-serviceaccountcredentials.html#cfn-appstream-directoryconfig-serviceaccountcredentials-accountpassword
*/
readonly accountPassword: string;
}
/**
* The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-certificatebasedauthproperties.html
*/
interface CertificateBasedAuthPropertiesProperty {
/**
* The ARN of the AWS Certificate Manager Private CA resource.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-certificatebasedauthproperties.html#cfn-appstream-directoryconfig-certificatebasedauthproperties-certificateauthorityarn
*/
readonly certificateAuthorityArn?: string;
/**
* The status of the certificate-based authentication properties.
*
* Fallback is turned on by default when certificate-based authentication is *Enabled* . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. *Enabled_no_directory_login_fallback* enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-certificatebasedauthproperties.html#cfn-appstream-directoryconfig-certificatebasedauthproperties-status
*/
readonly status?: string;
}
}
/**
* Properties for defining a `CfnDirectoryConfig`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-directoryconfig.html
*/
export interface CfnDirectoryConfigProps {
/**
* The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-directoryconfig.html#cfn-appstream-directoryconfig-certificatebasedauthproperties
*/
readonly certificateBasedAuthProperties?: CfnDirectoryConfig.CertificateBasedAuthPropertiesProperty | cdk.IResolvable;
/**
* The fully qualified name of the directory (for example, corp.example.com).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-directoryconfig.html#cfn-appstream-directoryconfig-directoryname
*/
readonly directoryName: string;
/**
* The distinguished names of the organizational units for computer accounts.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-directoryconfig.html#cfn-appstream-directoryconfig-organizationalunitdistinguishednames
*/
readonly organizationalUnitDistinguishedNames: Array<string>;
/**
* The credentials for the service account used by the streaming instance to connect to the directory.
*
* Do not use this parameter directly. Use `ServiceAccountCredentials` as an input parameter with `noEcho` as shown in the [Parameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html) . For best practices information, see [Do Not Embed Credentials in Your Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/best-practices.html#creds) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-directoryconfig.html#cfn-appstream-directoryconfig-serviceaccountcredentials
*/
readonly serviceAccountCredentials: cdk.IResolvable | CfnDirectoryConfig.ServiceAccountCredentialsProperty;
}
/**
* Creates an entitlement to control access, based on user attributes, to specific applications within a stack.
*
* Entitlements apply to SAML 2.0 federated user identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view application or to applications managed by a dynamic app provider using the Dynamic Application Framework.
*
* @cloudformationResource AWS::AppStream::Entitlement
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html
*/
export declare class CfnEntitlement extends cdk.CfnResource implements cdk.IInspectable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnEntitlement 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): CfnEntitlement;
/**
* The time when the entitlement was created.
*
* @cloudformationAttribute CreatedTime
*/
readonly attrCreatedTime: string;
/**
* The time when the entitlement was last modified.
*
* @cloudformationAttribute LastModifiedTime
*/
readonly attrLastModifiedTime: string;
/**
* Specifies whether to entitle all apps or only selected apps.
*/
appVisibility: string;
/**
* The attributes of the entitlement.
*/
attributes: Array<CfnEntitlement.AttributeProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The description of the entitlement.
*/
description?: string;
/**
* The name of the entitlement.
*/
name: string;
/**
* The name of the stack.
*/
stackName: string;
/**
* @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: CfnEntitlementProps);
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 CfnEntitlement {
/**
* An attribute that belongs to an entitlement.
*
* Application entitlements work by matching a supported SAML 2.0 attribute name to a value when a user identity federates to an AppStream 2.0 SAML application.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-entitlement-attribute.html
*/
interface AttributeProperty {
/**
* A supported AWS IAM SAML PrincipalTag attribute that is matched to a value when a user identity federates to an AppStream 2.0 SAML application.
*
* The following are supported values:
*
* - roles
* - department
* - organization
* - groups
* - title
* - costCenter
* - userType
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-entitlement-attribute.html#cfn-appstream-entitlement-attribute-name
*/
readonly name: string;
/**
* A value that is matched to a supported SAML attribute name when a user identity federates to an AppStream 2.0 SAML application.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-entitlement-attribute.html#cfn-appstream-entitlement-attribute-value
*/
readonly value: string;
}
}
/**
* Properties for defining a `CfnEntitlement`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html
*/
export interface CfnEntitlementProps {
/**
* Specifies whether to entitle all apps or only selected apps.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html#cfn-appstream-entitlement-appvisibility
*/
readonly appVisibility: string;
/**
* The attributes of the entitlement.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html#cfn-appstream-entitlement-attributes
*/
readonly attributes: Array<CfnEntitlement.AttributeProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The description of the entitlement.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html#cfn-appstream-entitlement-description
*/
readonly description?: string;
/**
* The name of the entitlement.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html#cfn-appstream-entitlement-name
*/
readonly name: string;
/**
* The name of the stack.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-entitlement.html#cfn-appstream-entitlement-stackname
*/
readonly stackName: string;
}
/**
* The `AWS::AppStream::Fleet` resource creates a fleet for Amazon AppStream 2.0. A fleet consists of streaming instances that run a specified image when using Always-On or On-Demand.
*
* @cloudformationResource AWS::AppStream::Fleet
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-fleet.html
*/
export declare class CfnFleet extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnFleet 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): CfnFleet;
/**
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* The desired capacity for the fleet.
*/
computeCapacity?: CfnFleet.ComputeCapacityProperty | cdk.IResolvable;
/**
* The description to display.
*/
description?: string;
/**
* The amount of time that a streaming session remains active after users disconnect.
*/
disconnectTimeoutInSeconds?: number;
/**
* The fleet name to display.
*/
displayName?: string;
/**
* The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
*/
domainJoinInfo?: CfnFleet.DomainJoinInfoProperty | cdk.IResolvable;
/**
* Enables or disables default internet access for the fleet.
*/
enableDefaultInternetAccess?: boolean | cdk.IResolvable;
/**
* The fleet type.
*/
fleetType?: string;
/**
* The ARN of the IAM role that is applied to the fleet.
*/
iamRoleArn?: string;
/**
* The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the `DisconnectTimeoutInSeconds` time interval begins.
*/
idleDisconnectTimeoutInSeconds?: number;
/**
* The ARN of the public, private, or shared image to use.
*/
imageArn?: string;
/**
* The name of the image used to create the fleet.
*/
imageName?: string;
/**
* The instance type to use when launching fleet instances. The following instance types are available for non-Elastic fleets:.
*/
instanceType: string;
/**
* The maximum number of concurrent sessions that can be run on an Elastic fleet.
*/
maxConcurrentSessions?: number;
/**
* Max number of user sessions on an instance.
*/
maxSessionsPerInstance?: number;
/**
* The maximum amount of time that a streaming session can remain active, in seconds.
*/
maxUserDurationInSeconds?: number;
/**
* A unique name for the fleet.
*/
name: string;
/**
* The platform of the fleet.
*/
platform?: string;
/**
* The S3 location of the session scripts configuration zip file.
*/
sessionScriptS3Location?: cdk.IResolvable | CfnFleet.S3LocationProperty;
/**
* The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When `APP` is specified, only the windows of applications opened by users display. When `DESKTOP` is specified, the standard desktop that is provided by the operating system displays.
*/
streamView?: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* An array of key-value pairs.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client.
*/
usbDeviceFilterStrings?: Array<string>;
/**
* The VPC configuration for the fleet.
*/
vpcConfig?: cdk.IResolvable | CfnFleet.VpcConfigProperty;
/**
* @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: CfnFleetProps);
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 CfnFleet {
/**
* The desir