aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
1,049 lines • 104 kB
TypeScript
import * as cdk from "../../core";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
/**
* 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 {
/**
* 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;
/**
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* A `Source` object that specifies the app repository.
*/
appSource?: cdk.IResolvable | CfnApp.SourceProperty;
/**
* One or more user-defined key/value pairs to be added to the stack attributes.
*/
attributes?: cdk.IResolvable | Record<string, string>;
/**
* The app's data source.
*/
dataSources?: Array<CfnApp.DataSourceProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* A description of the app.
*/
description?: string;
/**
* The app virtual host settings, with multiple domains separated by commas.
*/
domains?: Array<string>;
/**
* Whether to enable SSL for the app.
*/
enableSsl?: boolean | cdk.IResolvable;
/**
* An array of `EnvironmentVariable` objects that specify environment variables to be associated with the app.
*/
environment?: Array<CfnApp.EnvironmentVariableProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The app name.
*/
name: string;
/**
* The app's short name.
*/
shortname?: string;
/**
* An `SslConfiguration` object with the SSL configuration.
*/
sslConfiguration?: cdk.IResolvable | CfnApp.SslConfigurationProperty;
/**
* The stack ID.
*/
stackId: string;
/**
* The app type.
*/
type: 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: CfnAppProps);
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, AWS 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.
*
* AWS 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, AWS 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. AWS 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 {
/**
* 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;
/**
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* The Elastic Load Balancing instance name.
*/
elasticLoadBalancerName: string;
/**
* The AWS OpsWorks layer ID to which the Elastic Load Balancing load balancer is attached.
*/
layerId: 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: CfnElasticLoadBalancerAttachmentProps);
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 AWS 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 {
/**
* 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;
/**
* The Availability Zone of the AWS OpsWorks instance, such as `us-east-2a` .
*
* @cloudformationAttribute AvailabilityZone
*/
readonly attrAvailabilityZone: string;
/**
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* The private DNS name of the AWS OpsWorks instance.
*
* @cloudformationAttribute PrivateDnsName
*/
readonly attrPrivateDnsName: string;
/**
* The private IP address of the AWS OpsWorks instance, such as `192.0.2.0` .
*
* @cloudformationAttribute PrivateIp
*/
readonly attrPrivateIp: string;
/**
* The public DNS name of the AWS OpsWorks instance.
*
* @cloudformationAttribute PublicDnsName
*/
readonly attrPublicDnsName: string;
/**
* The public IP address of the AWS OpsWorks instance, such as `192.0.2.0` .
*
* > Use this attribute only when the AWS OpsWorks instance is in an AWS OpsWorks layer that auto-assigns public IP addresses.
*
* @cloudformationAttribute PublicIp
*/
readonly attrPublicIp: string;
/**
* The default AWS OpsWorks Stacks agent version. You have the following options:.
*/
agentVersion?: string;
/**
* A custom AMI ID to be used to create the instance.
*/
amiId?: string;
/**
* The instance architecture.
*/
architecture?: string;
/**
* For load-based or time-based instances, the type.
*/
autoScalingType?: string;
/**
* The Availability Zone of the AWS OpsWorks instance, such as `us-east-2a` .
*/
availabilityZone?: string;
/**
* An array of `BlockDeviceMapping` objects that specify the instance's block devices.
*/
blockDeviceMappings?: Array<CfnInstance.BlockDeviceMappingProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* Whether to create an Amazon EBS-optimized instance.
*/
ebsOptimized?: boolean | cdk.IResolvable;
/**
* A list of Elastic IP addresses to associate with the instance.
*/
elasticIps?: Array<string>;
/**
* The instance host name. The following are character limits for instance host names.
*/
hostname?: string;
/**
* Whether to install operating system and package updates when the instance boots.
*/
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.
*/
instanceType: string;
/**
* An array that contains the instance's layer IDs.
*/
layerIds: Array<string>;
/**
* The instance's operating system, which must be set to one of the following.
*/
os?: string;
/**
* The instance root device type.
*/
rootDeviceType?: string;
/**
* The instance's Amazon EC2 key-pair name.
*/
sshKeyName?: string;
/**
* The stack ID.
*/
stackId: string;
/**
* The ID of the instance's subnet.
*/
subnetId?: string;
/**
* The instance's tenancy option.
*/
tenancy?: string;
/**
* The time-based scaling configuration for the instance.
*/
timeBasedAutoScaling?: cdk.IResolvable | CfnInstance.TimeBasedAutoScalingProperty;
/**
* The instance's virtualization type, `paravirtual` or `hvm` .
*/
virtualizationType?: string;
/**
* A list of AWS OpsWorks volume IDs to associate with the instance.
*/
volumes?: Array<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: CfnInstanceProps);
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 AWS 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 AWS 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. AWS 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 AWS 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 [AWS 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 AWS 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
*/
readonly stackId: string;
/**
* The ID of the instance's subnet.
*
* If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-subnetid
*/
readonly subnetId?: string;
/**
* The instance's tenancy option.
*
* The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: `dedicated` , `default` , or `host` . Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see [Dedicated Hosts Overview](https://docs.aws.amazon.com/ec2/dedicated-hosts/) and [Amazon EC2 Dedicated Hosts](https://docs.aws.amazon.com/ec2/dedicated-hosts/) . For more information about dedicated instances, see [Dedicated Instances](https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/dedicated-instance.html) and [Amazon EC2 Dedicated Instances](https://docs.aws.amazon.com/ec2/purchasing-options/dedicated-instances/) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-tenancy
*/
readonly tenancy?: string;
/**
* The time-based scaling configuration for the instance.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-timebasedautoscaling
*/
readonly timeBasedAutoScaling?: cdk.IResolvable | CfnInstance.TimeBasedAutoScalingProperty;
/**
* The instance's virtualization type, `paravirtual` or `hvm` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-virtualizationtype
*/
readonly virtualizationType?: string;
/**
* A list of AWS OpsWorks volume IDs to associate with the instance.
*
* For more information, see [`AWS::OpsWorks::Volume`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-volumes
*/
readonly volumes?: Array<string>;
}
/**
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html.
*
* @cloudformationResource AWS::OpsWorks::Layer
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html
*/
export declare class CfnLayer 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 CfnLayer 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): CfnLayer;
/**
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* One or more user-defined key-value pairs to be added to the stack attributes.
*/
attributes?: cdk.IResolvable | Record<string, string>;
/**
* Whether to automatically assign an [Elastic IP address](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) to the layer's instances. For more information, see [How to Edit a Layer](https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html) .
*/
autoAssignElasticIps: boolean | cdk.IResolvable;
/**
* For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances.
*/
autoAssignPublicIps: boolean | cdk.IResolvable;
/**
* The ARN of an IAM profile to be used for the layer's EC2 instances.
*/
customInstanceProfileArn?: string;
/**
* A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances.
*/
customJson?: any | cdk.IResolvable;
/**
* A `LayerCustomRecipes` object that specifies the layer custom recipes.
*/
customRecipes?: cdk.IResolvable | CfnLayer.RecipesProperty;
/**
* An array containing the layer custom security group IDs.
*/
customSecurityGroupIds?: Array<string>;
/**
* Whether to disable auto healing for the layer.
*/
enableAutoHealing: boolean | cdk.IResolvable;
/**
* Whether to install operating system and package updates when the instance boots.
*/
installUpdatesOnBoot?: boolean | cdk.IResolvable;
/**
* A `LifeCycleEventConfiguration` object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.
*/
lifecycleEventConfiguration?: cdk.IResolvable | CfnLayer.LifecycleEventConfigurationProperty;
/**
* The load-based scaling configuration for the AWS OpsWorks layer.
*/
loadBasedAutoScaling?: cdk.IResolvable | CfnLayer.LoadBasedAutoScalingProperty;
/**
* The layer name, which is used by the console.
*/
name: string;
/**
* An array of `Package` objects that describes the layer packages.
*/
packages?: Array<string>;
/**
* For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef recipes.
*/
shortname: string;
/**
* The layer stack ID.
*/
stackId: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* Specifies one or more sets of tags (key–value pairs) to associate with this AWS OpsWorks layer.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* The layer type.
*/
type: string;
/**
* Whether to use Amazon EBS-optimized instances.
*/
useEbsOptimizedInstances?: boolean | cdk.IResolvable;
/**
* A `VolumeConfigurations` object that describes the layer's Amazon EBS volumes.
*/
volumeConfigurations?: Array<cdk.IResolvable | CfnLayer.VolumeConfigurationProperty> | cdk.IResolvable;
/**
* @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: CfnLayerProps);
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 CfnLayer {
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html
*/
interface RecipesProperty {
/**
* An array of custom recipe names to be run following a `configure` event.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-recipes-configure
*/
readonly configure?: Array<string>;
/**
* An array of custom recipe names to be run following a `deploy` event.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-recipes-deploy
*/
readonly deploy?: Array<string>;
/**
* An array of custom recipe names to be run following a `setup` event.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-recipes-setup
*/
readonly setup?: Array<string>;
/**
* An array of custom recipe names to be run following a `shutdown` event.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-recipes-shutdown
*/
readonly shutdown?: Array<string>;
/**
* An array of custom recipe names to be run following a `undeploy` event.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-recipes-undeploy
*/
readonly undeploy?: Array<string>;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-lifecycleeventconfiguration.html
*/
interface LifecycleEventConfigurationProperty {
/**
* The Shutdown event configuration.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-lifecycleeventconfiguration.html#cfn-opsworks-layer-lifecycleeventconfiguration-shutdowneventconfiguration
*/
readonly shutdownEventConfiguration?: cdk.IResolvable | CfnLayer.ShutdownEventConfigurationProperty;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-shutdowneventconfiguration.html
*/
interface ShutdownEventConfigurationProperty {
/**
* Whether to enable Elastic Load Balancing connection draining.
*
* For more information, see [Connection Draining](https://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#conn-drain)
*
* @see http://docs.aws.amazon.com/AWSCl