aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
1,130 lines • 132 kB
TypeScript
import * as cdk from "../../core/lib";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
import { AppReference, ElasticLoadBalancerAttachmentReference, IAppRef, IElasticLoadBalancerAttachmentRef, IInstanceRef, ILayerRef, InstanceReference, IStackRef, IUserProfileRef, IVolumeRef, LayerReference, StackReference, UserProfileReference, VolumeReference } from "../../interfaces/generated/aws-opsworks-interfaces.generated";
/**
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html.
*
* @cloudformationResource AWS::OpsWorks::App
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html
*/
export declare class CfnApp extends cdk.CfnResource implements cdk.IInspectable, IAppRef {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnApp 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): CfnApp;
/**
* Checks whether the given object is a CfnApp
*/
static isCfnApp(x: any): x is CfnApp;
/**
* A `Source` object that specifies the app repository.
*/
private _appSource?;
/**
* One or more user-defined key/value pairs to be added to the stack attributes.
*/
private _attributes?;
/**
* The app's data source.
*/
private _dataSources?;
/**
* A description of the app.
*/
private _description?;
/**
* The app virtual host settings, with multiple domains separated by commas.
*/
private _domains?;
/**
* Whether to enable SSL for the app.
*/
private _enableSsl?;
/**
* An array of `EnvironmentVariable` objects that specify environment variables to be associated with the app.
*/
private _environment?;
/**
* The app name.
*/
private _name;
/**
* The app's short name.
*/
private _shortname?;
/**
* An `SslConfiguration` object with the SSL configuration.
*/
private _sslConfiguration?;
/**
* The stack ID.
*/
private _stackId;
/**
* The app type.
*/
private _type;
/**
* Create a new `AWS::OpsWorks::App`.
*
* @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: CfnAppProps);
get appRef(): AppReference;
/**
* A `Source` object that specifies the app repository.
*/
get appSource(): cdk.IResolvable | CfnApp.SourceProperty | undefined;
/**
* A `Source` object that specifies the app repository.
*/
set appSource(value: cdk.IResolvable | CfnApp.SourceProperty | undefined);
/**
* One or more user-defined key/value pairs to be added to the stack attributes.
*/
get attributes(): cdk.IResolvable | Record<string, string> | undefined;
/**
* One or more user-defined key/value pairs to be added to the stack attributes.
*/
set attributes(value: cdk.IResolvable | Record<string, string> | undefined);
/**
* The app's data source.
*/
get dataSources(): Array<CfnApp.DataSourceProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
/**
* The app's data source.
*/
set dataSources(value: Array<CfnApp.DataSourceProperty | cdk.IResolvable> | cdk.IResolvable | undefined);
/**
* A description of the app.
*/
get description(): string | undefined;
/**
* A description of the app.
*/
set description(value: string | undefined);
/**
* The app virtual host settings, with multiple domains separated by commas.
*/
get domains(): Array<string> | undefined;
/**
* The app virtual host settings, with multiple domains separated by commas.
*/
set domains(value: Array<string> | undefined);
/**
* Whether to enable SSL for the app.
*/
get enableSsl(): boolean | cdk.IResolvable | undefined;
/**
* Whether to enable SSL for the app.
*/
set enableSsl(value: boolean | cdk.IResolvable | undefined);
/**
* An array of `EnvironmentVariable` objects that specify environment variables to be associated with the app.
*/
get environment(): Array<CfnApp.EnvironmentVariableProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
/**
* An array of `EnvironmentVariable` objects that specify environment variables to be associated with the app.
*/
set environment(value: Array<CfnApp.EnvironmentVariableProperty | cdk.IResolvable> | cdk.IResolvable | undefined);
/**
* The app name.
*/
get name(): string;
/**
* The app name.
*/
set name(value: string);
/**
* The app's short name.
*/
get shortname(): string | undefined;
/**
* The app's short name.
*/
set shortname(value: string | undefined);
/**
* An `SslConfiguration` object with the SSL configuration.
*/
get sslConfiguration(): cdk.IResolvable | CfnApp.SslConfigurationProperty | undefined;
/**
* An `SslConfiguration` object with the SSL configuration.
*/
set sslConfiguration(value: cdk.IResolvable | CfnApp.SslConfigurationProperty | undefined);
/**
* The stack ID.
*/
get stackId(): string;
/**
* The stack ID.
*/
set stackId(value: string);
/**
* The app type.
*/
get type(): string;
/**
* The app type.
*/
set type(value: string);
/**
* @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 CfnApp {
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-source.html
*/
interface SourceProperty {
/**
* When included in a request, the parameter depends on the repository type.
*
* - For Amazon S3 bundles, set `Password` to the appropriate IAM secret access key.
* - For HTTP bundles and Subversion repositories, set `Password` to the password.
*
* For more information on how to safely handle IAM credentials, see [](https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html) .
*
* In responses, OpsWorks Stacks returns `*****FILTERED*****` instead of the actual value.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-source.html#cfn-opsworks-app-source-password
*/
readonly password?: string;
/**
* The application's version.
*
* OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-source.html#cfn-opsworks-app-source-revision
*/
readonly revision?: string;
/**
* In requests, the repository's SSH key.
*
* In responses, OpsWorks Stacks returns `*****FILTERED*****` instead of the actual value.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-source.html#cfn-opsworks-app-source-sshkey
*/
readonly sshKey?: string;
/**
* The repository type.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-source.html#cfn-opsworks-app-source-type
*/
readonly type?: string;
/**
* The source URL.
*
* The following is an example of an Amazon S3 source URL: `https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-source.html#cfn-opsworks-app-source-url
*/
readonly url?: string;
/**
* This parameter depends on the repository type.
*
* - For Amazon S3 bundles, set `Username` to the appropriate IAM access key ID.
* - For HTTP bundles, Git repositories, and Subversion repositories, set `Username` to the user name.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-source.html#cfn-opsworks-app-source-username
*/
readonly username?: string;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html
*/
interface DataSourceProperty {
/**
* The data source's ARN.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html#cfn-opsworks-app-datasource-arn
*/
readonly arn?: string;
/**
* The database name.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html#cfn-opsworks-app-datasource-databasename
*/
readonly databaseName?: string;
/**
* The data source's type, `AutoSelectOpsworksMysqlInstance` , `OpsworksMysqlInstance` , `RdsDbInstance` , or `None` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html#cfn-opsworks-app-datasource-type
*/
readonly type?: string;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environmentvariable.html
*/
interface EnvironmentVariableProperty {
/**
* (Required) The environment variable's name, which can consist of up to 64 characters and must be specified.
*
* The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environmentvariable.html#cfn-opsworks-app-environmentvariable-key
*/
readonly key: string;
/**
* (Optional) Whether the variable's value is returned by the `DescribeApps` action.
*
* To hide an environment variable's value, set `Secure` to `true` . `DescribeApps` returns `*****FILTERED*****` instead of the actual value. The default value for `Secure` is `false` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environmentvariable.html#cfn-opsworks-app-environmentvariable-secure
*/
readonly secure?: boolean | cdk.IResolvable;
/**
* (Optional) The environment variable's value, which can be left empty.
*
* If you specify a value, it can contain up to 256 characters, which must all be printable.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environmentvariable.html#cfn-opsworks-app-environmentvariable-value
*/
readonly value: string;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-sslconfiguration.html
*/
interface SslConfigurationProperty {
/**
* The contents of the certificate's domain.crt file.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-sslconfiguration.html#cfn-opsworks-app-sslconfiguration-certificate
*/
readonly certificate?: string;
/**
* Optional.
*
* Can be used to specify an intermediate certificate authority key or client authentication.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-sslconfiguration.html#cfn-opsworks-app-sslconfiguration-chain
*/
readonly chain?: string;
/**
* The private key;
*
* the contents of the certificate's domain.kex file.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-sslconfiguration.html#cfn-opsworks-app-sslconfiguration-privatekey
*/
readonly privateKey?: string;
}
}
/**
* Properties for defining a `CfnApp`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html
*/
export interface CfnAppProps {
/**
* A `Source` object that specifies the app repository.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-appsource
*/
readonly appSource?: cdk.IResolvable | CfnApp.SourceProperty;
/**
* One or more user-defined key/value pairs to be added to the stack attributes.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-attributes
*/
readonly attributes?: cdk.IResolvable | Record<string, string>;
/**
* The app's data source.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-datasources
*/
readonly dataSources?: Array<CfnApp.DataSourceProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* A description of the app.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-description
*/
readonly description?: string;
/**
* The app virtual host settings, with multiple domains separated by commas.
*
* For example: `'www.example.com, example.com'`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-domains
*/
readonly domains?: Array<string>;
/**
* Whether to enable SSL for the app.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-enablessl
*/
readonly enableSsl?: boolean | cdk.IResolvable;
/**
* An array of `EnvironmentVariable` objects that specify environment variables to be associated with the app.
*
* After you deploy the app, these variables are defined on the associated app server instance. For more information, see [Environment Variables](https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment) .
*
* There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 20KB)."
*
* > If you have specified one or more environment variables, you cannot modify the stack's Chef version.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-environment
*/
readonly environment?: Array<CfnApp.EnvironmentVariableProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The app name.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-name
*/
readonly name: string;
/**
* The app's short name.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-shortname
*/
readonly shortname?: string;
/**
* An `SslConfiguration` object with the SSL configuration.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-sslconfiguration
*/
readonly sslConfiguration?: cdk.IResolvable | CfnApp.SslConfigurationProperty;
/**
* The stack ID.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-stackid
*/
readonly stackId: string;
/**
* The app type.
*
* Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. OpsWorks Stacks deploys an application to those instances that are members of the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy recipes, specify `other` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-type
*/
readonly type: string;
}
/**
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-elbattachment.html.
*
* @cloudformationResource AWS::OpsWorks::ElasticLoadBalancerAttachment
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-elasticloadbalancerattachment.html
*/
export declare class CfnElasticLoadBalancerAttachment extends cdk.CfnResource implements cdk.IInspectable, IElasticLoadBalancerAttachmentRef {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnElasticLoadBalancerAttachment 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): CfnElasticLoadBalancerAttachment;
/**
* Checks whether the given object is a CfnElasticLoadBalancerAttachment
*/
static isCfnElasticLoadBalancerAttachment(x: any): x is CfnElasticLoadBalancerAttachment;
/**
* The Elastic Load Balancing instance name.
*/
private _elasticLoadBalancerName;
/**
* The OpsWorks layer ID to which the Elastic Load Balancing load balancer is attached.
*/
private _layerId;
/**
* Create a new `AWS::OpsWorks::ElasticLoadBalancerAttachment`.
*
* @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: CfnElasticLoadBalancerAttachmentProps);
get elasticLoadBalancerAttachmentRef(): ElasticLoadBalancerAttachmentReference;
/**
* The Elastic Load Balancing instance name.
*/
get elasticLoadBalancerName(): string;
/**
* The Elastic Load Balancing instance name.
*/
set elasticLoadBalancerName(value: string);
/**
* The OpsWorks layer ID to which the Elastic Load Balancing load balancer is attached.
*/
get layerId(): string;
/**
* The OpsWorks layer ID to which the Elastic Load Balancing load balancer is attached.
*/
set layerId(value: string);
/**
* @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>;
}
/**
* Properties for defining a `CfnElasticLoadBalancerAttachment`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-elasticloadbalancerattachment.html
*/
export interface CfnElasticLoadBalancerAttachmentProps {
/**
* The Elastic Load Balancing instance name.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-elasticloadbalancerattachment.html#cfn-opsworks-elasticloadbalancerattachment-elasticloadbalancername
*/
readonly elasticLoadBalancerName: string;
/**
* The OpsWorks layer ID to which the Elastic Load Balancing load balancer is attached.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-elasticloadbalancerattachment.html#cfn-opsworks-elasticloadbalancerattachment-layerid
*/
readonly layerId: string;
}
/**
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html.
*
* @cloudformationResource AWS::OpsWorks::Instance
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html
*/
export declare class CfnInstance extends cdk.CfnResource implements cdk.IInspectable, IInstanceRef {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnInstance 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): CfnInstance;
/**
* Checks whether the given object is a CfnInstance
*/
static isCfnInstance(x: any): x is CfnInstance;
/**
* The default OpsWorks Stacks agent version. You have the following options:.
*/
private _agentVersion?;
/**
* A custom AMI ID to be used to create the instance.
*/
private _amiId?;
/**
* The instance architecture.
*/
private _architecture?;
/**
* For load-based or time-based instances, the type.
*/
private _autoScalingType?;
/**
* The Availability Zone of the OpsWorks instance, such as `us-east-2a` .
*/
private _availabilityZone?;
/**
* An array of `BlockDeviceMapping` objects that specify the instance's block devices.
*/
private _blockDeviceMappings?;
/**
* Whether to create an Amazon EBS-optimized instance.
*/
private _ebsOptimized?;
/**
* A list of Elastic IP addresses to associate with the instance.
*/
private _elasticIps?;
/**
* The instance host name. The following are character limits for instance host names.
*/
private _hostname?;
/**
* Whether to install operating system and package updates when the instance boots.
*/
private _installUpdatesOnBoot?;
/**
* The instance type, such as `t2.micro` . For a list of supported instance types, open the stack in the console, choose *Instances* , and choose *+ Instance* . The *Size* list contains the currently supported types. For more information, see [Instance Families and Types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) . The parameter values that you use to specify the various types are in the *API Name* column of the *Available Instance Types* table.
*/
private _instanceType;
/**
* An array that contains the instance's layer IDs.
*/
private _layerIds;
/**
* The instance's operating system, which must be set to one of the following.
*/
private _os?;
/**
* The instance root device type.
*/
private _rootDeviceType?;
/**
* The instance's Amazon EC2 key-pair name.
*/
private _sshKeyName?;
/**
* The stack ID.
*/
private _stackId;
/**
* The ID of the instance's subnet.
*/
private _subnetId?;
/**
* The instance's tenancy option.
*/
private _tenancy?;
/**
* The time-based scaling configuration for the instance.
*/
private _timeBasedAutoScaling?;
/**
* The instance's virtualization type, `paravirtual` or `hvm` .
*/
private _virtualizationType?;
/**
* A list of OpsWorks volume IDs to associate with the instance.
*/
private _volumes?;
/**
* Create a new `AWS::OpsWorks::Instance`.
*
* @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: CfnInstanceProps);
get instanceRef(): InstanceReference;
/**
* The default OpsWorks Stacks agent version. You have the following options:.
*/
get agentVersion(): string | undefined;
/**
* The default OpsWorks Stacks agent version. You have the following options:.
*/
set agentVersion(value: string | undefined);
/**
* A custom AMI ID to be used to create the instance.
*/
get amiId(): string | undefined;
/**
* A custom AMI ID to be used to create the instance.
*/
set amiId(value: string | undefined);
/**
* The instance architecture.
*/
get architecture(): string | undefined;
/**
* The instance architecture.
*/
set architecture(value: string | undefined);
/**
* For load-based or time-based instances, the type.
*/
get autoScalingType(): string | undefined;
/**
* For load-based or time-based instances, the type.
*/
set autoScalingType(value: string | undefined);
/**
* The Availability Zone of the OpsWorks instance, such as `us-east-2a` .
*/
get availabilityZone(): string | undefined;
/**
* The Availability Zone of the OpsWorks instance, such as `us-east-2a` .
*/
set availabilityZone(value: string | undefined);
/**
* An array of `BlockDeviceMapping` objects that specify the instance's block devices.
*/
get blockDeviceMappings(): Array<CfnInstance.BlockDeviceMappingProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
/**
* An array of `BlockDeviceMapping` objects that specify the instance's block devices.
*/
set blockDeviceMappings(value: Array<CfnInstance.BlockDeviceMappingProperty | cdk.IResolvable> | cdk.IResolvable | undefined);
/**
* Whether to create an Amazon EBS-optimized instance.
*/
get ebsOptimized(): boolean | cdk.IResolvable | undefined;
/**
* Whether to create an Amazon EBS-optimized instance.
*/
set ebsOptimized(value: boolean | cdk.IResolvable | undefined);
/**
* A list of Elastic IP addresses to associate with the instance.
*/
get elasticIps(): Array<string> | undefined;
/**
* A list of Elastic IP addresses to associate with the instance.
*/
set elasticIps(value: Array<string> | undefined);
/**
* The instance host name. The following are character limits for instance host names.
*/
get hostname(): string | undefined;
/**
* The instance host name. The following are character limits for instance host names.
*/
set hostname(value: string | undefined);
/**
* Whether to install operating system and package updates when the instance boots.
*/
get installUpdatesOnBoot(): boolean | cdk.IResolvable | undefined;
/**
* Whether to install operating system and package updates when the instance boots.
*/
set installUpdatesOnBoot(value: boolean | cdk.IResolvable | undefined);
/**
* The instance type, such as `t2.micro` . For a list of supported instance types, open the stack in the console, choose *Instances* , and choose *+ Instance* . The *Size* list contains the currently supported types. For more information, see [Instance Families and Types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) . The parameter values that you use to specify the various types are in the *API Name* column of the *Available Instance Types* table.
*/
get instanceType(): string;
/**
* The instance type, such as `t2.micro` . For a list of supported instance types, open the stack in the console, choose *Instances* , and choose *+ Instance* . The *Size* list contains the currently supported types. For more information, see [Instance Families and Types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) . The parameter values that you use to specify the various types are in the *API Name* column of the *Available Instance Types* table.
*/
set instanceType(value: string);
/**
* An array that contains the instance's layer IDs.
*/
get layerIds(): Array<string>;
/**
* An array that contains the instance's layer IDs.
*/
set layerIds(value: Array<string>);
/**
* The instance's operating system, which must be set to one of the following.
*/
get os(): string | undefined;
/**
* The instance's operating system, which must be set to one of the following.
*/
set os(value: string | undefined);
/**
* The instance root device type.
*/
get rootDeviceType(): string | undefined;
/**
* The instance root device type.
*/
set rootDeviceType(value: string | undefined);
/**
* The instance's Amazon EC2 key-pair name.
*/
get sshKeyName(): string | undefined;
/**
* The instance's Amazon EC2 key-pair name.
*/
set sshKeyName(value: string | undefined);
/**
* The stack ID.
*/
get stackId(): string;
/**
* The stack ID.
*/
set stackId(value: string);
/**
* The ID of the instance's subnet.
*/
get subnetId(): string | undefined;
/**
* The ID of the instance's subnet.
*/
set subnetId(value: string | undefined);
/**
* The instance's tenancy option.
*/
get tenancy(): string | undefined;
/**
* The instance's tenancy option.
*/
set tenancy(value: string | undefined);
/**
* The time-based scaling configuration for the instance.
*/
get timeBasedAutoScaling(): cdk.IResolvable | CfnInstance.TimeBasedAutoScalingProperty | undefined;
/**
* The time-based scaling configuration for the instance.
*/
set timeBasedAutoScaling(value: cdk.IResolvable | CfnInstance.TimeBasedAutoScalingProperty | undefined);
/**
* The instance's virtualization type, `paravirtual` or `hvm` .
*/
get virtualizationType(): string | undefined;
/**
* The instance's virtualization type, `paravirtual` or `hvm` .
*/
set virtualizationType(value: string | undefined);
/**
* A list of OpsWorks volume IDs to associate with the instance.
*/
get volumes(): Array<string> | undefined;
/**
* A list of OpsWorks volume IDs to associate with the instance.
*/
set volumes(value: Array<string> | undefined);
/**
* The Availability Zone of the OpsWorks instance, such as `us-east-2a` .
*
* @cloudformationAttribute AvailabilityZone
*/
get attrAvailabilityZone(): string;
/**
* @cloudformationAttribute Id
*/
get attrId(): string;
/**
* The private DNS name of the OpsWorks instance.
*
* @cloudformationAttribute PrivateDnsName
*/
get attrPrivateDnsName(): string;
/**
* The private IP address of the OpsWorks instance, such as `192.0.2.0` .
*
* @cloudformationAttribute PrivateIp
*/
get attrPrivateIp(): string;
/**
* The public DNS name of the OpsWorks instance.
*
* @cloudformationAttribute PublicDnsName
*/
get attrPublicDnsName(): string;
/**
* The public IP address of the OpsWorks instance, such as `192.0.2.0` .
*
* > Use this attribute only when the OpsWorks instance is in an OpsWorks layer that auto-assigns public IP addresses.
*
* @cloudformationAttribute PublicIp
*/
get attrPublicIp(): 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 CfnInstance {
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html
*/
interface BlockDeviceMappingProperty {
/**
* The device name that is exposed to the instance, such as `/dev/sdh` .
*
* For the root device, you can use the explicit device name or you can set this parameter to `ROOT_DEVICE` and OpsWorks Stacks will provide the correct device name.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-devicename
*/
readonly deviceName?: string;
/**
* An `EBSBlockDevice` that defines how to configure an Amazon EBS volume when the instance is launched.
*
* You can specify either the `VirtualName` or `Ebs` , but not both.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-ebs
*/
readonly ebs?: CfnInstance.EbsBlockDeviceProperty | cdk.IResolvable;
/**
* Suppresses the specified device included in the AMI's block device mapping.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-nodevice
*/
readonly noDevice?: string;
/**
* The virtual device name.
*
* For more information, see [BlockDeviceMapping](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html) . You can specify either the `VirtualName` or `Ebs` , but not both.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-virtualname
*/
readonly virtualName?: string;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html
*/
interface EbsBlockDeviceProperty {
/**
* Whether the volume is deleted on instance termination.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-deleteontermination
*/
readonly deleteOnTermination?: boolean | cdk.IResolvable;
/**
* The number of I/O operations per second (IOPS) that the volume supports.
*
* For more information, see [EbsBlockDevice](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-iops
*/
readonly iops?: number;
/**
* The snapshot ID.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-snapshotid
*/
readonly snapshotId?: string;
/**
* The volume size, in GiB.
*
* For more information, see [EbsBlockDevice](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-volumesize
*/
readonly volumeSize?: number;
/**
* The volume type.
*
* `gp2` for General Purpose (SSD) volumes, `io1` for Provisioned IOPS (SSD) volumes, `st1` for Throughput Optimized hard disk drives (HDD), `sc1` for Cold HDD,and `standard` for Magnetic volumes.
*
* If you specify the `io1` volume type, you must also specify a value for the `Iops` attribute. The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume size).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-volumetype
*/
readonly volumeType?: string;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html
*/
interface TimeBasedAutoScalingProperty {
/**
* The schedule for Friday.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-friday
*/
readonly friday?: cdk.IResolvable | Record<string, string>;
/**
* The schedule for Monday.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-monday
*/
readonly monday?: cdk.IResolvable | Record<string, string>;
/**
* The schedule for Saturday.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-saturday
*/
readonly saturday?: cdk.IResolvable | Record<string, string>;
/**
* The schedule for Sunday.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-sunday
*/
readonly sunday?: cdk.IResolvable | Record<string, string>;
/**
* The schedule for Thursday.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-thursday
*/
readonly thursday?: cdk.IResolvable | Record<string, string>;
/**
* The schedule for Tuesday.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-tuesday
*/
readonly tuesday?: cdk.IResolvable | Record<string, string>;
/**
* The schedule for Wednesday.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-wednesday
*/
readonly wednesday?: cdk.IResolvable | Record<string, string>;
}
}
/**
* Properties for defining a `CfnInstance`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html
*/
export interface CfnInstanceProps {
/**
* The default OpsWorks Stacks agent version. You have the following options:.
*
* - `INHERIT` - Use the stack's default agent version setting.
* - *version_number* - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. OpsWorks Stacks installs that version on the instance.
*
* The default setting is `INHERIT` . To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call `DescribeAgentVersions` . AgentVersion cannot be set to Chef 12.2.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-agentversion
*/
readonly agentVersion?: string;
/**
* A custom AMI ID to be used to create the instance.
*
* The AMI should be based on one of the supported operating systems. For more information, see [Using Custom AMIs](https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html) .
*
* > If you specify a custom AMI, you must set `Os` to `Custom` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-amiid
*/
readonly amiId?: string;
/**
* The instance architecture.
*
* The default option is `x86_64` . Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see [Instance Families and Types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-architecture
*/
readonly architecture?: string;
/**
* For load-based or time-based instances, the type.
*
* Windows stacks can use only time-based instances.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-autoscalingtype
*/
readonly autoScalingType?: string;
/**
* The Availability Zone of the OpsWorks instance, such as `us-east-2a` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-availabilityzone
*/
readonly availabilityZone?: string;
/**
* An array of `BlockDeviceMapping` objects that specify the instance's block devices.
*
* For more information, see [Block Device Mapping](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) . Note that block device mappings are not supported for custom AMIs.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-blockdevicemappings
*/
readonly blockDeviceMappings?: Array<CfnInstance.BlockDeviceMappingProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* Whether to create an Amazon EBS-optimized instance.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-ebsoptimized
*/
readonly ebsOptimized?: boolean | cdk.IResolvable;
/**
* A list of Elastic IP addresses to associate with the instance.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-elasticips
*/
readonly elasticIps?: Array<string>;
/**
* The instance host name. The following are character limits for instance host names.
*
* - Linux-based instances: 63 characters
* - Windows-based instances: 15 characters
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-hostname
*/
readonly hostname?: string;
/**
* Whether to install operating system and package updates when the instance boots.
*
* The default value is `true` . To control when updates are installed, set this value to `false` . You must then update your instances manually by using `CreateDeployment` to run the `update_dependencies` stack command or by manually running `yum` (Amazon Linux) or `apt-get` (Ubuntu) on the instances.
*
* > We strongly recommend using the default value of `true` to ensure that your instances have the latest security updates.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-installupdatesonboot
*/
readonly installUpdatesOnBoot?: boolean | cdk.IResolvable;
/**
* The instance type, such as `t2.micro` . For a list of supported instance types, open the stack in the console, choose *Instances* , and choose *+ Instance* . The *Size* list contains the currently supported types. For more information, see [Instance Families and Types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) . The parameter values that you use to specify the various types are in the *API Name* column of the *Available Instance Types* table.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-instancetype
*/
readonly instanceType: string;
/**
* An array that contains the instance's layer IDs.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-layerids
*/
readonly layerIds: Array<string>;
/**
* The instance's operating system, which must be set to one of the following.
*
* - A supported Linux operating system: An Amazon Linux version, such as `Amazon Linux 2` , `Amazon Linux 2018.03` , `Amazon Linux 2017.09` , `Amazon Linux 2017.03` , `Amazon Linux 2016.09` , `Amazon Linux 2016.03` , `Amazon Linux 2015.09` , or `Amazon Linux 2015.03` .
* - A supported Ubuntu operating system, such as `Ubuntu 18.04 LTS` , `Ubuntu 16.04 LTS` , `Ubuntu 14.04 LTS` , or `Ubuntu 12.04 LTS` .
* - `CentOS Linux 7`
* - `Red Hat Enterprise Linux 7`
* - A supported Windows operating system, such as `Microsoft Windows Server 2012 R2 Base` , `Microsoft Windows Server 2012 R2 with SQL Server Express` , `Microsoft Windows Server 2012 R2 with SQL Server Standard` , or `Microsoft Windows Server 2012 R2 with SQL Server Web` .
* - A custom AMI: `Custom` .
*
* Not all operating systems are supported with all versions of Chef. For more information about the supported operating systems, see [OpsWorks Stacks Operating Systems](https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html) .
*
* The default option is the current Amazon Linux version. If you set this parameter to `Custom` , you must use the `CreateInstance` action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is `Custom` . For more information about how to use custom AMIs with OpsWorks Stacks, see [Using Custom AMIs](https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-os
*/
readonly os?: string;
/**
* The instance root device type.
*
* For more information, see [Storage for the Root Device](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-rootdevicetype
*/
readonly rootDeviceType?: string;
/**
* The instance's Amazon EC2 key-pair name.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-sshkeyname
*/
readonly sshKeyName?: string;
/**
* The stack ID.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-stackid
*/
readonl