UNPKG

aws-cdk-lib

Version:

Version 2 of the AWS Cloud Development Kit library

794 lines (793 loc) 34.5 kB
import * as cdk from "../../core/lib"; import * as constructs from "constructs"; import * as cfn_parse from "../../core/lib/helpers-internal"; import { ApplicationReference, DeploymentReference, EnvironmentReference, IApplicationRef, IDeploymentRef, IEnvironmentRef } from "../../interfaces/generated/aws-m2-interfaces.generated"; /** * Specifies a new application with given parameters. Requires an existing runtime environment and application definition file. * * For information about application definitions, see the [AWS Mainframe Modernization User Guide](https://docs.aws.amazon.com/m2/latest/userguide/applications-m2-definition.html) . * * @cloudformationResource AWS::M2::Application * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html */ export declare class CfnApplication extends cdk.CfnResource implements cdk.IInspectable, IApplicationRef, 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; /** * Checks whether the given object is a CfnApplication */ static isCfnApplication(x: any): x is CfnApplication; static arnForApplication(resource: IApplicationRef): string; /** * The application definition for a particular application. You can specify either inline JSON or an Amazon S3 bucket location. */ private _definition?; /** * The description of the application. */ private _description?; /** * The type of the target platform for this application. */ private _engineType; /** * The identifier of a customer managed key. */ private _kmsKeyId?; /** * The name of the application. */ private _name; /** * The Amazon Resource Name (ARN) of the role associated with the application. */ private _roleArn?; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * An array of key-value pairs to apply to this resource. */ private _tagsRaw?; /** * Create a new `AWS::M2::Application`. * * @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); get applicationRef(): ApplicationReference; /** * The application definition for a particular application. You can specify either inline JSON or an Amazon S3 bucket location. */ get definition(): CfnApplication.DefinitionProperty | cdk.IResolvable | undefined; /** * The application definition for a particular application. You can specify either inline JSON or an Amazon S3 bucket location. */ set definition(value: CfnApplication.DefinitionProperty | cdk.IResolvable | undefined); /** * The description of the application. */ get description(): string | undefined; /** * The description of the application. */ set description(value: string | undefined); /** * The type of the target platform for this application. */ get engineType(): string; /** * The type of the target platform for this application. */ set engineType(value: string); /** * The identifier of a customer managed key. */ get kmsKeyId(): string | undefined; /** * The identifier of a customer managed key. */ set kmsKeyId(value: string | undefined); /** * The name of the application. */ get name(): string; /** * The name of the application. */ set name(value: string); /** * The Amazon Resource Name (ARN) of the role associated with the application. */ get roleArn(): string | undefined; /** * The Amazon Resource Name (ARN) of the role associated with the application. */ set roleArn(value: string | undefined); /** * An array of key-value pairs to apply to this resource. */ get tagsRaw(): Record<string, string> | undefined; /** * An array of key-value pairs to apply to this resource. */ set tagsRaw(value: Record<string, string> | undefined); /** * The Amazon Resource Name (ARN) of the application. * * @cloudformationAttribute ApplicationArn */ get attrApplicationArn(): string; /** * The identifier of the application. * * @cloudformationAttribute ApplicationId */ get attrApplicationId(): 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 CfnApplication { /** * The application definition for a particular application. * * You can specify either inline JSON or an Amazon S3 bucket location. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-application-definition.html */ interface DefinitionProperty { /** * The content of the application definition. * * This is a JSON object that contains the resource configuration/definitions that identify an application. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-application-definition.html#cfn-m2-application-definition-content */ readonly content?: string; /** * The S3 bucket that contains the application definition. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-application-definition.html#cfn-m2-application-definition-s3location */ readonly s3Location?: string; } } /** * Properties for defining a `CfnApplication` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html */ export interface CfnApplicationProps { /** * The application definition for a particular application. You can specify either inline JSON or an Amazon S3 bucket location. * * For information about application definitions, see the [AWS Mainframe Modernization User Guide](https://docs.aws.amazon.com/m2/latest/userguide/applications-m2-definition.html) . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-definition */ readonly definition?: CfnApplication.DefinitionProperty | cdk.IResolvable; /** * The description of the application. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-description */ readonly description?: string; /** * The type of the target platform for this application. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-enginetype */ readonly engineType: string; /** * The identifier of a customer managed key. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-kmskeyid */ readonly kmsKeyId?: string; /** * The name of the application. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-name */ readonly name: string; /** * The Amazon Resource Name (ARN) of the role associated with the application. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-rolearn */ readonly roleArn?: string; /** * An array of key-value pairs to apply to this resource. * * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-application.html#cfn-m2-application-tags */ readonly tags?: Record<string, string>; } /** * Specifies a runtime environment for a given runtime engine. * * @cloudformationResource AWS::M2::Environment * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html */ export declare class CfnEnvironment extends cdk.CfnResource implements cdk.IInspectable, IEnvironmentRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnEnvironment 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): CfnEnvironment; /** * Checks whether the given object is a CfnEnvironment */ static isCfnEnvironment(x: any): x is CfnEnvironment; static arnForEnvironment(resource: IEnvironmentRef): string; /** * The description of the runtime environment. */ private _description?; /** * The target platform for the runtime environment. */ private _engineType; /** * The version of the runtime engine. */ private _engineVersion?; /** * > AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. */ private _highAvailabilityConfig?; /** * The instance type of the runtime environment. */ private _instanceType; /** * The identifier of a customer managed key. */ private _kmsKeyId?; /** * The name of the runtime environment. */ private _name; /** * The network type supported by the runtime environment. */ private _networkType?; /** * Configures the maintenance window that you want for the runtime environment. */ private _preferredMaintenanceWindow?; /** * Specifies whether the runtime environment is publicly accessible. */ private _publiclyAccessible?; /** * The list of security groups for the VPC associated with this runtime environment. */ private _securityGroupIds?; /** * > AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. */ private _storageConfigurations?; /** * The list of subnets associated with the VPC for this runtime environment. */ private _subnetIds?; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * An array of key-value pairs to apply to this resource. */ private _tagsRaw?; /** * Create a new `AWS::M2::Environment`. * * @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: CfnEnvironmentProps); get environmentRef(): EnvironmentReference; /** * The description of the runtime environment. */ get description(): string | undefined; /** * The description of the runtime environment. */ set description(value: string | undefined); /** * The target platform for the runtime environment. */ get engineType(): string; /** * The target platform for the runtime environment. */ set engineType(value: string); /** * The version of the runtime engine. */ get engineVersion(): string | undefined; /** * The version of the runtime engine. */ set engineVersion(value: string | undefined); /** * > AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. */ get highAvailabilityConfig(): CfnEnvironment.HighAvailabilityConfigProperty | cdk.IResolvable | undefined; /** * > AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. */ set highAvailabilityConfig(value: CfnEnvironment.HighAvailabilityConfigProperty | cdk.IResolvable | undefined); /** * The instance type of the runtime environment. */ get instanceType(): string; /** * The instance type of the runtime environment. */ set instanceType(value: string); /** * The identifier of a customer managed key. */ get kmsKeyId(): string | undefined; /** * The identifier of a customer managed key. */ set kmsKeyId(value: string | undefined); /** * The name of the runtime environment. */ get name(): string; /** * The name of the runtime environment. */ set name(value: string); /** * The network type supported by the runtime environment. */ get networkType(): string | undefined; /** * The network type supported by the runtime environment. */ set networkType(value: string | undefined); /** * Configures the maintenance window that you want for the runtime environment. */ get preferredMaintenanceWindow(): string | undefined; /** * Configures the maintenance window that you want for the runtime environment. */ set preferredMaintenanceWindow(value: string | undefined); /** * Specifies whether the runtime environment is publicly accessible. */ get publiclyAccessible(): boolean | cdk.IResolvable | undefined; /** * Specifies whether the runtime environment is publicly accessible. */ set publiclyAccessible(value: boolean | cdk.IResolvable | undefined); /** * The list of security groups for the VPC associated with this runtime environment. */ get securityGroupIds(): Array<string> | undefined; /** * The list of security groups for the VPC associated with this runtime environment. */ set securityGroupIds(value: Array<string> | undefined); /** * > AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. */ get storageConfigurations(): Array<cdk.IResolvable | CfnEnvironment.StorageConfigurationProperty> | cdk.IResolvable | undefined; /** * > AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. */ set storageConfigurations(value: Array<cdk.IResolvable | CfnEnvironment.StorageConfigurationProperty> | cdk.IResolvable | undefined); /** * The list of subnets associated with the VPC for this runtime environment. */ get subnetIds(): Array<string> | undefined; /** * The list of subnets associated with the VPC for this runtime environment. */ set subnetIds(value: Array<string> | undefined); /** * An array of key-value pairs to apply to this resource. */ get tagsRaw(): Record<string, string> | undefined; /** * An array of key-value pairs to apply to this resource. */ set tagsRaw(value: Record<string, string> | undefined); /** * The Amazon Resource Name (ARN) of the runtime environment. * * @cloudformationAttribute EnvironmentArn */ get attrEnvironmentArn(): string; /** * The unique identifier of the runtime environment. * * @cloudformationAttribute EnvironmentId */ get attrEnvironmentId(): 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 CfnEnvironment { /** * > AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. * * If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html) . * * Defines the details of a high availability configuration. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-highavailabilityconfig.html */ interface HighAvailabilityConfigProperty { /** * The number of instances in a high availability configuration. * * The minimum possible value is 1 and the maximum is 100. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-highavailabilityconfig.html#cfn-m2-environment-highavailabilityconfig-desiredcapacity */ readonly desiredCapacity: number; } /** * > AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. * * If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html) . * * Defines the storage configuration for a runtime environment. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-storageconfiguration.html */ interface StorageConfigurationProperty { /** * Defines the storage configuration for an Amazon EFS file system. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-storageconfiguration.html#cfn-m2-environment-storageconfiguration-efs */ readonly efs?: CfnEnvironment.EfsStorageConfigurationProperty | cdk.IResolvable; /** * Defines the storage configuration for an Amazon FSx file system. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-storageconfiguration.html#cfn-m2-environment-storageconfiguration-fsx */ readonly fsx?: CfnEnvironment.FsxStorageConfigurationProperty | cdk.IResolvable; } /** * > AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. * * If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html) . * * Defines the storage configuration for an Amazon EFS file system. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-efsstorageconfiguration.html */ interface EfsStorageConfigurationProperty { /** * The file system identifier. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-efsstorageconfiguration.html#cfn-m2-environment-efsstorageconfiguration-filesystemid */ readonly fileSystemId: string; /** * The mount point for the file system. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-efsstorageconfiguration.html#cfn-m2-environment-efsstorageconfiguration-mountpoint */ readonly mountPoint: string; } /** * > AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. * * If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html) . * * Defines the storage configuration for an Amazon FSx file system. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-fsxstorageconfiguration.html */ interface FsxStorageConfigurationProperty { /** * The file system identifier. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-fsxstorageconfiguration.html#cfn-m2-environment-fsxstorageconfiguration-filesystemid */ readonly fileSystemId: string; /** * The mount point for the file system. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-fsxstorageconfiguration.html#cfn-m2-environment-fsxstorageconfiguration-mountpoint */ readonly mountPoint: string; } } /** * Properties for defining a `CfnEnvironment` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html */ export interface CfnEnvironmentProps { /** * The description of the runtime environment. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-description */ readonly description?: string; /** * The target platform for the runtime environment. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-enginetype */ readonly engineType: string; /** * The version of the runtime engine. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-engineversion */ readonly engineVersion?: string; /** * > AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. * * If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html) . * * Defines the details of a high availability configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-highavailabilityconfig */ readonly highAvailabilityConfig?: CfnEnvironment.HighAvailabilityConfigProperty | cdk.IResolvable; /** * The instance type of the runtime environment. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-instancetype */ readonly instanceType: string; /** * The identifier of a customer managed key. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-kmskeyid */ readonly kmsKeyId?: string; /** * The name of the runtime environment. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-name */ readonly name: string; /** * The network type supported by the runtime environment. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-networktype */ readonly networkType?: string; /** * Configures the maintenance window that you want for the runtime environment. * * The maintenance window must have the format `ddd:hh24:mi-ddd:hh24:mi` and must be less than 24 hours. The following two examples are valid maintenance windows: `sun:23:45-mon:00:15` or `sat:01:00-sat:03:00` . * * If you do not provide a value, a random system-generated value will be assigned. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-preferredmaintenancewindow */ readonly preferredMaintenanceWindow?: string; /** * Specifies whether the runtime environment is publicly accessible. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-publiclyaccessible */ readonly publiclyAccessible?: boolean | cdk.IResolvable; /** * The list of security groups for the VPC associated with this runtime environment. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-securitygroupids */ readonly securityGroupIds?: Array<string>; /** * > AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. * * If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html) . * * Defines the storage configuration for a runtime environment. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-storageconfigurations */ readonly storageConfigurations?: Array<cdk.IResolvable | CfnEnvironment.StorageConfigurationProperty> | cdk.IResolvable; /** * The list of subnets associated with the VPC for this runtime environment. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-subnetids */ readonly subnetIds?: Array<string>; /** * An array of key-value pairs to apply to this resource. * * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-tags */ readonly tags?: Record<string, string>; } /** * > AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. * * If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html) . * * Creates and starts a deployment to deploy an application into a runtime environment. * * @cloudformationResource AWS::M2::Deployment * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-deployment.html */ export declare class CfnDeployment extends cdk.CfnResource implements cdk.IInspectable, IDeploymentRef { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnDeployment 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): CfnDeployment; /** * Checks whether the given object is a CfnDeployment */ static isCfnDeployment(x: any): x is CfnDeployment; /** * The unique identifier of the application. */ private _applicationId; /** * The version of the application. */ private _applicationVersion; /** * The unique identifier of the runtime environment. */ private _environmentId; /** * Create a new `AWS::M2::Deployment`. * * @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: CfnDeploymentProps); get deploymentRef(): DeploymentReference; /** * The unique identifier of the application. */ get applicationId(): string; /** * The unique identifier of the application. */ set applicationId(value: string); /** * The version of the application. */ get applicationVersion(): number; /** * The version of the application. */ set applicationVersion(value: number); /** * The unique identifier of the runtime environment. */ get environmentId(): string; /** * The unique identifier of the runtime environment. */ set environmentId(value: string); /** * The unique identifier of the deployment. * * @cloudformationAttribute DeploymentId */ get attrDeploymentId(): string; /** * The current status of the deployment. * * @cloudformationAttribute Status */ get attrStatus(): 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 `CfnDeployment` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-deployment.html */ export interface CfnDeploymentProps { /** * The unique identifier of the application. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-deployment.html#cfn-m2-deployment-applicationid */ readonly applicationId: string; /** * The version of the application. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-deployment.html#cfn-m2-deployment-applicationversion */ readonly applicationVersion: number; /** * The unique identifier of the runtime environment. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-deployment.html#cfn-m2-deployment-environmentid */ readonly environmentId: string; } export type { IApplicationRef, ApplicationReference }; export type { IEnvironmentRef, EnvironmentReference }; export type { IDeploymentRef, DeploymentReference };