2018/02/05 - AWS OpsWorks - 1 new 6 updated api methods
Changes AWS OpsWorks Stacks supports EBS encryption and HDD volume types. Also, a new DescribeOperatingSystems API is available, which lists all operating systems supported by OpsWorks Stacks.
Describes the operating systems that are supported by AWS OpsWorks Stacks.
See also: AWS API Documentation
Request Syntax
client.describe_operating_systems()
dict
Response Syntax
{
'OperatingSystems': [
{
'Name': 'string',
'Id': 'string',
'Type': 'string',
'ConfigurationManagers': [
{
'Name': 'string',
'Version': 'string'
},
],
'ReportedName': 'string',
'ReportedVersion': 'string',
'Supported': True|False
},
]
}
Response Structure
(dict) --
The response to a DescribeOperatingSystems request.
OperatingSystems (list) --
(dict) --
Describes supported operating systems in AWS OpsWorks Stacks.
Name (string) --
The name of the operating system, such as Amazon Linux 2017.09 .
Id (string) --
The ID of a supported operating system, such as Amazon Linux 2017.09 .
Type (string) --
The type of a supported operating system, either Linux or Windows .
ConfigurationManagers (list) --
Supported configuration manager name and versions for an AWS OpsWorks Stacks operating system.
(dict) --
A block that contains information about the configuration manager (Chef) and the versions of the configuration manager that are supported for an operating system.
Name (string) --
The name of the configuration manager, which is Chef.
Version (string) --
The versions of the configuration manager that are supported by an operating system.
ReportedName (string) --
A short name for the operating system manufacturer.
ReportedVersion (string) --
The version of the operating system, including the release and edition, if applicable.
Supported (boolean) --
Indicates that an operating system is not supported for new instances.
{'VolumeConfigurations': {'Encrypted': 'boolean'}}
Creates a layer. For more information, see How to Create a Layer.
Note
You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary number of custom layers, so you can call CreateLayer as many times as you like for that layer type.
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
See also: AWS API Documentation
Request Syntax
client.create_layer(
StackId='string',
Type='aws-flow-ruby'|'ecs-cluster'|'java-app'|'lb'|'web'|'php-app'|'rails-app'|'nodejs-app'|'memcached'|'db-master'|'monitoring-master'|'custom',
Name='string',
Shortname='string',
Attributes={
'string': 'string'
},
CloudWatchLogsConfiguration={
'Enabled': True|False,
'LogStreams': [
{
'LogGroupName': 'string',
'DatetimeFormat': 'string',
'TimeZone': 'LOCAL'|'UTC',
'File': 'string',
'FileFingerprintLines': 'string',
'MultiLineStartPattern': 'string',
'InitialPosition': 'start_of_file'|'end_of_file',
'Encoding': 'ascii'|'big5'|'big5hkscs'|'cp037'|'cp424'|'cp437'|'cp500'|'cp720'|'cp737'|'cp775'|'cp850'|'cp852'|'cp855'|'cp856'|'cp857'|'cp858'|'cp860'|'cp861'|'cp862'|'cp863'|'cp864'|'cp865'|'cp866'|'cp869'|'cp874'|'cp875'|'cp932'|'cp949'|'cp950'|'cp1006'|'cp1026'|'cp1140'|'cp1250'|'cp1251'|'cp1252'|'cp1253'|'cp1254'|'cp1255'|'cp1256'|'cp1257'|'cp1258'|'euc_jp'|'euc_jis_2004'|'euc_jisx0213'|'euc_kr'|'gb2312'|'gbk'|'gb18030'|'hz'|'iso2022_jp'|'iso2022_jp_1'|'iso2022_jp_2'|'iso2022_jp_2004'|'iso2022_jp_3'|'iso2022_jp_ext'|'iso2022_kr'|'latin_1'|'iso8859_2'|'iso8859_3'|'iso8859_4'|'iso8859_5'|'iso8859_6'|'iso8859_7'|'iso8859_8'|'iso8859_9'|'iso8859_10'|'iso8859_13'|'iso8859_14'|'iso8859_15'|'iso8859_16'|'johab'|'koi8_r'|'koi8_u'|'mac_cyrillic'|'mac_greek'|'mac_iceland'|'mac_latin2'|'mac_roman'|'mac_turkish'|'ptcp154'|'shift_jis'|'shift_jis_2004'|'shift_jisx0213'|'utf_32'|'utf_32_be'|'utf_32_le'|'utf_16'|'utf_16_be'|'utf_16_le'|'utf_7'|'utf_8'|'utf_8_sig',
'BufferDuration': 123,
'BatchCount': 123,
'BatchSize': 123
},
]
},
CustomInstanceProfileArn='string',
CustomJson='string',
CustomSecurityGroupIds=[
'string',
],
Packages=[
'string',
],
VolumeConfigurations=[
{
'MountPoint': 'string',
'RaidLevel': 123,
'NumberOfDisks': 123,
'Size': 123,
'VolumeType': 'string',
'Iops': 123,
'Encrypted': True|False
},
],
EnableAutoHealing=True|False,
AutoAssignElasticIps=True|False,
AutoAssignPublicIps=True|False,
CustomRecipes={
'Setup': [
'string',
],
'Configure': [
'string',
],
'Deploy': [
'string',
],
'Undeploy': [
'string',
],
'Shutdown': [
'string',
]
},
InstallUpdatesOnBoot=True|False,
UseEbsOptimizedInstances=True|False,
LifecycleEventConfiguration={
'Shutdown': {
'ExecutionTimeout': 123,
'DelayUntilElbConnectionsDrained': True|False
}
}
)
string
[REQUIRED]
The layer stack ID.
string
[REQUIRED]
The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks.
string
[REQUIRED]
The layer name, which is used by the console.
string
[REQUIRED]
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. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.
The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference.
dict
One or more user-defined key-value pairs to be added to the stack attributes.
To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.
(string) --
(string) --
dict
Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.
Enabled (boolean) --
Whether CloudWatch Logs is enabled for a layer.
LogStreams (list) --
A list of configuration options for CloudWatch Logs.
(dict) --
Describes the Amazon CloudWatch logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference.
LogGroupName (string) --
Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).
DatetimeFormat (string) --
Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.
TimeZone (string) --
Specifies the time zone of log event time stamps.
File (string) --
Specifies log files that you want to push to CloudWatch Logs.
File can point to a specific file or multiple files (by using wild card characters such as /var/log/system.log* ). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as access_log.2014-06-01-01 , access_log.2014-06-01-02 , and so on by using a pattern like access_log.* . Don't use a wildcard to match multiple file types, such as access_log_80 and access_log_443 . To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group.
Zipped files are not supported.
FileFingerprintLines (string) --
Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available.
MultiLineStartPattern (string) --
Specifies the pattern for identifying the start of a log message.
InitialPosition (string) --
Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream.
Encoding (string) --
Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8 . Encodings supported by Python codecs.decode() can be used here.
BufferDuration (integer) --
Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.
BatchCount (integer) --
Specifies the max number of log events in a batch, up to 10000. The default value is 1000.
BatchSize (integer) --
Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
string
The ARN of an IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
string
A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON. This feature is supported as of version 1.7.42 of the AWS CLI.
list
An array containing the layer custom security group IDs.
(string) --
list
An array of Package objects that describes the layer packages.
(string) --
list
A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
(dict) --
Describes an Amazon EBS volume configuration.
MountPoint (string) -- [REQUIRED]
The volume mount point. For example "/dev/sdh".
RaidLevel (integer) --
The volume RAID level.
NumberOfDisks (integer) -- [REQUIRED]
The number of disks in the volume.
Size (integer) -- [REQUIRED]
The volume size.
VolumeType (string) --
The volume type. For more information, see Amazon EBS Volume Types.
standard - Magnetic
io1 - Provisioned IOPS (SSD)
gp2 - General Purpose (SSD)
st1 - Throughput Optimized hard disk drive (HDD)
sc1 - Cold HDD
Iops (integer) --
For PIOPS volumes, the IOPS per disk.
Encrypted (boolean) --
Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
boolean
Whether to disable auto healing for the layer.
boolean
Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
boolean
For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.
dict
A LayerCustomRecipes object that specifies the layer custom recipes.
Setup (list) --
An array of custom recipe names to be run following a setup event.
(string) --
Configure (list) --
An array of custom recipe names to be run following a configure event.
(string) --
Deploy (list) --
An array of custom recipe names to be run following a deploy event.
(string) --
Undeploy (list) --
An array of custom recipe names to be run following a undeploy event.
(string) --
Shutdown (list) --
An array of custom recipe names to be run following a shutdown event.
(string) --
boolean
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.
Note
To ensure that your instances have the latest security updates, we strongly recommend using the default value of true .
boolean
Whether to use Amazon EBS-optimized instances.
dict
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.
Shutdown (dict) --
A ShutdownEventConfiguration object that specifies the Shutdown event configuration.
ExecutionTimeout (integer) --
The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a Shutdown event before shutting down an instance.
DelayUntilElbConnectionsDrained (boolean) --
Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining
dict
Response Syntax
{
'LayerId': 'string'
}
Response Structure
(dict) --
Contains the response to a CreateLayer request.
LayerId (string) --
The layer ID.
{'Layers': {'VolumeConfigurations': {'Encrypted': 'boolean'}}}
Requests a description of one or more layers in a specified stack.
Note
This call accepts only one resource-identifying parameter.
Required Permissions : To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
See also: AWS API Documentation
Request Syntax
client.describe_layers(
StackId='string',
LayerIds=[
'string',
]
)
string
The stack ID.
list
An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified stack.
(string) --
dict
Response Syntax
{
'Layers': [
{
'Arn': 'string',
'StackId': 'string',
'LayerId': 'string',
'Type': 'aws-flow-ruby'|'ecs-cluster'|'java-app'|'lb'|'web'|'php-app'|'rails-app'|'nodejs-app'|'memcached'|'db-master'|'monitoring-master'|'custom',
'Name': 'string',
'Shortname': 'string',
'Attributes': {
'string': 'string'
},
'CloudWatchLogsConfiguration': {
'Enabled': True|False,
'LogStreams': [
{
'LogGroupName': 'string',
'DatetimeFormat': 'string',
'TimeZone': 'LOCAL'|'UTC',
'File': 'string',
'FileFingerprintLines': 'string',
'MultiLineStartPattern': 'string',
'InitialPosition': 'start_of_file'|'end_of_file',
'Encoding': 'ascii'|'big5'|'big5hkscs'|'cp037'|'cp424'|'cp437'|'cp500'|'cp720'|'cp737'|'cp775'|'cp850'|'cp852'|'cp855'|'cp856'|'cp857'|'cp858'|'cp860'|'cp861'|'cp862'|'cp863'|'cp864'|'cp865'|'cp866'|'cp869'|'cp874'|'cp875'|'cp932'|'cp949'|'cp950'|'cp1006'|'cp1026'|'cp1140'|'cp1250'|'cp1251'|'cp1252'|'cp1253'|'cp1254'|'cp1255'|'cp1256'|'cp1257'|'cp1258'|'euc_jp'|'euc_jis_2004'|'euc_jisx0213'|'euc_kr'|'gb2312'|'gbk'|'gb18030'|'hz'|'iso2022_jp'|'iso2022_jp_1'|'iso2022_jp_2'|'iso2022_jp_2004'|'iso2022_jp_3'|'iso2022_jp_ext'|'iso2022_kr'|'latin_1'|'iso8859_2'|'iso8859_3'|'iso8859_4'|'iso8859_5'|'iso8859_6'|'iso8859_7'|'iso8859_8'|'iso8859_9'|'iso8859_10'|'iso8859_13'|'iso8859_14'|'iso8859_15'|'iso8859_16'|'johab'|'koi8_r'|'koi8_u'|'mac_cyrillic'|'mac_greek'|'mac_iceland'|'mac_latin2'|'mac_roman'|'mac_turkish'|'ptcp154'|'shift_jis'|'shift_jis_2004'|'shift_jisx0213'|'utf_32'|'utf_32_be'|'utf_32_le'|'utf_16'|'utf_16_be'|'utf_16_le'|'utf_7'|'utf_8'|'utf_8_sig',
'BufferDuration': 123,
'BatchCount': 123,
'BatchSize': 123
},
]
},
'CustomInstanceProfileArn': 'string',
'CustomJson': 'string',
'CustomSecurityGroupIds': [
'string',
],
'DefaultSecurityGroupNames': [
'string',
],
'Packages': [
'string',
],
'VolumeConfigurations': [
{
'MountPoint': 'string',
'RaidLevel': 123,
'NumberOfDisks': 123,
'Size': 123,
'VolumeType': 'string',
'Iops': 123,
'Encrypted': True|False
},
],
'EnableAutoHealing': True|False,
'AutoAssignElasticIps': True|False,
'AutoAssignPublicIps': True|False,
'DefaultRecipes': {
'Setup': [
'string',
],
'Configure': [
'string',
],
'Deploy': [
'string',
],
'Undeploy': [
'string',
],
'Shutdown': [
'string',
]
},
'CustomRecipes': {
'Setup': [
'string',
],
'Configure': [
'string',
],
'Deploy': [
'string',
],
'Undeploy': [
'string',
],
'Shutdown': [
'string',
]
},
'CreatedAt': 'string',
'InstallUpdatesOnBoot': True|False,
'UseEbsOptimizedInstances': True|False,
'LifecycleEventConfiguration': {
'Shutdown': {
'ExecutionTimeout': 123,
'DelayUntilElbConnectionsDrained': True|False
}
}
},
]
}
Response Structure
(dict) --
Contains the response to a DescribeLayers request.
Layers (list) --
An array of Layer objects that describe the layers.
(dict) --
Describes a layer.
Arn (string) --
StackId (string) --
The layer stack ID.
LayerId (string) --
The layer ID.
Type (string) --
The layer type.
Name (string) --
The layer name.
Shortname (string) --
The layer short name.
Attributes (dict) --
The layer attributes.
For the HaproxyStatsPassword , MysqlRootPassword , and GangliaPassword attributes, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value
For an ECS Cluster layer, AWS OpsWorks Stacks the EcsClusterArn attribute is set to the cluster's ARN.
(string) --
(string) --
CloudWatchLogsConfiguration (dict) --
The Amazon CloudWatch Logs configuration settings for the layer.
Enabled (boolean) --
Whether CloudWatch Logs is enabled for a layer.
LogStreams (list) --
A list of configuration options for CloudWatch Logs.
(dict) --
Describes the Amazon CloudWatch logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference.
LogGroupName (string) --
Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).
DatetimeFormat (string) --
Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.
TimeZone (string) --
Specifies the time zone of log event time stamps.
File (string) --
Specifies log files that you want to push to CloudWatch Logs.
File can point to a specific file or multiple files (by using wild card characters such as /var/log/system.log* ). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as access_log.2014-06-01-01 , access_log.2014-06-01-02 , and so on by using a pattern like access_log.* . Don't use a wildcard to match multiple file types, such as access_log_80 and access_log_443 . To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group.
Zipped files are not supported.
FileFingerprintLines (string) --
Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available.
MultiLineStartPattern (string) --
Specifies the pattern for identifying the start of a log message.
InitialPosition (string) --
Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream.
Encoding (string) --
Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8 . Encodings supported by Python codecs.decode() can be used here.
BufferDuration (integer) --
Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.
BatchCount (integer) --
Specifies the max number of log events in a batch, up to 10000. The default value is 1000.
BatchSize (integer) --
Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
CustomInstanceProfileArn (string) --
The ARN of the default IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
CustomJson (string) --
A JSON formatted string containing the layer's custom stack configuration and deployment attributes.
CustomSecurityGroupIds (list) --
An array containing the layer's custom security group IDs.
(string) --
DefaultSecurityGroupNames (list) --
An array containing the layer's security group names.
(string) --
Packages (list) --
An array of Package objects that describe the layer's packages.
(string) --
VolumeConfigurations (list) --
A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
(dict) --
Describes an Amazon EBS volume configuration.
MountPoint (string) --
The volume mount point. For example "/dev/sdh".
RaidLevel (integer) --
The volume RAID level.
NumberOfDisks (integer) --
The number of disks in the volume.
Size (integer) --
The volume size.
VolumeType (string) --
The volume type. For more information, see Amazon EBS Volume Types.
standard - Magnetic
io1 - Provisioned IOPS (SSD)
gp2 - General Purpose (SSD)
st1 - Throughput Optimized hard disk drive (HDD)
sc1 - Cold HDD
Iops (integer) --
For PIOPS volumes, the IOPS per disk.
Encrypted (boolean) --
Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
EnableAutoHealing (boolean) --
Whether auto healing is disabled for the layer.
AutoAssignElasticIps (boolean) --
Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
AutoAssignPublicIps (boolean) --
For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.
DefaultRecipes (dict) --
AWS OpsWorks Stacks supports five lifecycle events: setup , configuration , deploy , undeploy , and shutdown . For each layer, AWS OpsWorks Stacks runs a set of standard recipes for each event. In addition, you can provide custom recipes for any or all layers and events. AWS OpsWorks Stacks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.
To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.
Setup (list) --
An array of custom recipe names to be run following a setup event.
(string) --
Configure (list) --
An array of custom recipe names to be run following a configure event.
(string) --
Deploy (list) --
An array of custom recipe names to be run following a deploy event.
(string) --
Undeploy (list) --
An array of custom recipe names to be run following a undeploy event.
(string) --
Shutdown (list) --
An array of custom recipe names to be run following a shutdown event.
(string) --
CustomRecipes (dict) --
A LayerCustomRecipes object that specifies the layer's custom recipes.
Setup (list) --
An array of custom recipe names to be run following a setup event.
(string) --
Configure (list) --
An array of custom recipe names to be run following a configure event.
(string) --
Deploy (list) --
An array of custom recipe names to be run following a deploy event.
(string) --
Undeploy (list) --
An array of custom recipe names to be run following a undeploy event.
(string) --
Shutdown (list) --
An array of custom recipe names to be run following a shutdown event.
(string) --
CreatedAt (string) --
Date when the layer was created.
InstallUpdatesOnBoot (boolean) --
Whether to install operating system and package updates when the instance boots. The default value is true . If this value is set to false , you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
Note
We strongly recommend using the default value of true , to ensure that your instances have the latest security updates.
UseEbsOptimizedInstances (boolean) --
Whether the layer uses Amazon EBS-optimized instances.
LifecycleEventConfiguration (dict) --
A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.
Shutdown (dict) --
A ShutdownEventConfiguration object that specifies the Shutdown event configuration.
ExecutionTimeout (integer) --
The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a Shutdown event before shutting down an instance.
DelayUntilElbConnectionsDrained (boolean) --
Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining
{'StackSummary': {'InstancesCount': {'StopFailed': 'integer'}}}
Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup or online .
Required Permissions : To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
See also: AWS API Documentation
Request Syntax
client.describe_stack_summary(
StackId='string'
)
string
[REQUIRED]
The stack ID.
dict
Response Syntax
{
'StackSummary': {
'StackId': 'string',
'Name': 'string',
'Arn': 'string',
'LayersCount': 123,
'AppsCount': 123,
'InstancesCount': {
'Assigning': 123,
'Booting': 123,
'ConnectionLost': 123,
'Deregistering': 123,
'Online': 123,
'Pending': 123,
'Rebooting': 123,
'Registered': 123,
'Registering': 123,
'Requested': 123,
'RunningSetup': 123,
'SetupFailed': 123,
'ShuttingDown': 123,
'StartFailed': 123,
'StopFailed': 123,
'Stopped': 123,
'Stopping': 123,
'Terminated': 123,
'Terminating': 123,
'Unassigning': 123
}
}
}
Response Structure
(dict) --
Contains the response to a DescribeStackSummary request.
StackSummary (dict) --
A StackSummary object that contains the results.
StackId (string) --
The stack ID.
Name (string) --
The stack name.
Arn (string) --
The stack's ARN.
LayersCount (integer) --
The number of layers.
AppsCount (integer) --
The number of apps.
InstancesCount (dict) --
An InstancesCount object with the number of instances in each status.
Assigning (integer) --
The number of instances in the Assigning state.
Booting (integer) --
The number of instances with booting status.
ConnectionLost (integer) --
The number of instances with connection_lost status.
Deregistering (integer) --
The number of instances in the Deregistering state.
Online (integer) --
The number of instances with online status.
Pending (integer) --
The number of instances with pending status.
Rebooting (integer) --
The number of instances with rebooting status.
Registered (integer) --
The number of instances in the Registered state.
Registering (integer) --
The number of instances in the Registering state.
Requested (integer) --
The number of instances with requested status.
RunningSetup (integer) --
The number of instances with running_setup status.
SetupFailed (integer) --
The number of instances with setup_failed status.
ShuttingDown (integer) --
The number of instances with shutting_down status.
StartFailed (integer) --
The number of instances with start_failed status.
StopFailed (integer) --
Stopped (integer) --
The number of instances with stopped status.
Stopping (integer) --
The number of instances with stopping status.
Terminated (integer) --
The number of instances with terminated status.
Terminating (integer) --
The number of instances with terminating status.
Unassigning (integer) --
The number of instances in the Unassigning state.
{'Volumes': {'Encrypted': 'boolean'}}
Describes an instance's Amazon EBS volumes.
Note
This call accepts only one resource-identifying parameter.
Required Permissions : To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
See also: AWS API Documentation
Request Syntax
client.describe_volumes(
InstanceId='string',
StackId='string',
RaidArrayId='string',
VolumeIds=[
'string',
]
)
string
The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.
string
A stack ID. The action describes the stack's registered Amazon EBS volumes.
string
The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.
list
Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.
(string) --
dict
Response Syntax
{
'Volumes': [
{
'VolumeId': 'string',
'Ec2VolumeId': 'string',
'Name': 'string',
'RaidArrayId': 'string',
'InstanceId': 'string',
'Status': 'string',
'Size': 123,
'Device': 'string',
'MountPoint': 'string',
'Region': 'string',
'AvailabilityZone': 'string',
'VolumeType': 'string',
'Iops': 123,
'Encrypted': True|False
},
]
}
Response Structure
(dict) --
Contains the response to a DescribeVolumes request.
Volumes (list) --
An array of volume IDs.
(dict) --
Describes an instance's Amazon EBS volume.
VolumeId (string) --
The volume ID.
Ec2VolumeId (string) --
The Amazon EC2 volume ID.
Name (string) --
The volume name.
RaidArrayId (string) --
The RAID array ID.
InstanceId (string) --
The instance ID.
Status (string) --
The value returned by DescribeVolumes.
Size (integer) --
The volume size.
Device (string) --
The device name.
MountPoint (string) --
The volume mount point. For example, "/mnt/disk1".
Region (string) --
The AWS region. For more information about AWS regions, see Regions and Endpoints.
AvailabilityZone (string) --
The volume Availability Zone. For more information, see Regions and Endpoints.
VolumeType (string) --
The volume type, standard or PIOPS.
Iops (integer) --
For PIOPS volumes, the IOPS per disk.
Encrypted (boolean) --
{'Force': 'boolean'}
Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
See also: AWS API Documentation
Request Syntax
client.stop_instance(
InstanceId='string',
Force=True|False
)
string
[REQUIRED]
The instance ID.
boolean
None
{'VolumeConfigurations': {'Encrypted': 'boolean'}}
Updates a specified layer.
Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
See also: AWS API Documentation
Request Syntax
client.update_layer(
LayerId='string',
Name='string',
Shortname='string',
Attributes={
'string': 'string'
},
CloudWatchLogsConfiguration={
'Enabled': True|False,
'LogStreams': [
{
'LogGroupName': 'string',
'DatetimeFormat': 'string',
'TimeZone': 'LOCAL'|'UTC',
'File': 'string',
'FileFingerprintLines': 'string',
'MultiLineStartPattern': 'string',
'InitialPosition': 'start_of_file'|'end_of_file',
'Encoding': 'ascii'|'big5'|'big5hkscs'|'cp037'|'cp424'|'cp437'|'cp500'|'cp720'|'cp737'|'cp775'|'cp850'|'cp852'|'cp855'|'cp856'|'cp857'|'cp858'|'cp860'|'cp861'|'cp862'|'cp863'|'cp864'|'cp865'|'cp866'|'cp869'|'cp874'|'cp875'|'cp932'|'cp949'|'cp950'|'cp1006'|'cp1026'|'cp1140'|'cp1250'|'cp1251'|'cp1252'|'cp1253'|'cp1254'|'cp1255'|'cp1256'|'cp1257'|'cp1258'|'euc_jp'|'euc_jis_2004'|'euc_jisx0213'|'euc_kr'|'gb2312'|'gbk'|'gb18030'|'hz'|'iso2022_jp'|'iso2022_jp_1'|'iso2022_jp_2'|'iso2022_jp_2004'|'iso2022_jp_3'|'iso2022_jp_ext'|'iso2022_kr'|'latin_1'|'iso8859_2'|'iso8859_3'|'iso8859_4'|'iso8859_5'|'iso8859_6'|'iso8859_7'|'iso8859_8'|'iso8859_9'|'iso8859_10'|'iso8859_13'|'iso8859_14'|'iso8859_15'|'iso8859_16'|'johab'|'koi8_r'|'koi8_u'|'mac_cyrillic'|'mac_greek'|'mac_iceland'|'mac_latin2'|'mac_roman'|'mac_turkish'|'ptcp154'|'shift_jis'|'shift_jis_2004'|'shift_jisx0213'|'utf_32'|'utf_32_be'|'utf_32_le'|'utf_16'|'utf_16_be'|'utf_16_le'|'utf_7'|'utf_8'|'utf_8_sig',
'BufferDuration': 123,
'BatchCount': 123,
'BatchSize': 123
},
]
},
CustomInstanceProfileArn='string',
CustomJson='string',
CustomSecurityGroupIds=[
'string',
],
Packages=[
'string',
],
VolumeConfigurations=[
{
'MountPoint': 'string',
'RaidLevel': 123,
'NumberOfDisks': 123,
'Size': 123,
'VolumeType': 'string',
'Iops': 123,
'Encrypted': True|False
},
],
EnableAutoHealing=True|False,
AutoAssignElasticIps=True|False,
AutoAssignPublicIps=True|False,
CustomRecipes={
'Setup': [
'string',
],
'Configure': [
'string',
],
'Deploy': [
'string',
],
'Undeploy': [
'string',
],
'Shutdown': [
'string',
]
},
InstallUpdatesOnBoot=True|False,
UseEbsOptimizedInstances=True|False,
LifecycleEventConfiguration={
'Shutdown': {
'ExecutionTimeout': 123,
'DelayUntilElbConnectionsDrained': True|False
}
}
)
string
[REQUIRED]
The layer ID.
string
The layer name, which is used by the console.
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. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /A[a-z0-9-_.]+Z/.
The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference
dict
One or more user-defined key/value pairs to be added to the stack attributes.
(string) --
(string) --
dict
Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.
Enabled (boolean) --
Whether CloudWatch Logs is enabled for a layer.
LogStreams (list) --
A list of configuration options for CloudWatch Logs.
(dict) --
Describes the Amazon CloudWatch logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference.
LogGroupName (string) --
Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).
DatetimeFormat (string) --
Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.
TimeZone (string) --
Specifies the time zone of log event time stamps.
File (string) --
Specifies log files that you want to push to CloudWatch Logs.
File can point to a specific file or multiple files (by using wild card characters such as /var/log/system.log* ). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as access_log.2014-06-01-01 , access_log.2014-06-01-02 , and so on by using a pattern like access_log.* . Don't use a wildcard to match multiple file types, such as access_log_80 and access_log_443 . To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group.
Zipped files are not supported.
FileFingerprintLines (string) --
Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available.
MultiLineStartPattern (string) --
Specifies the pattern for identifying the start of a log message.
InitialPosition (string) --
Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream.
Encoding (string) --
Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8 . Encodings supported by Python codecs.decode() can be used here.
BufferDuration (integer) --
Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.
BatchCount (integer) --
Specifies the max number of log events in a batch, up to 10000. The default value is 1000.
BatchSize (integer) --
Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
string
The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
string
A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON.
list
An array containing the layer's custom security group IDs.
(string) --
list
An array of Package objects that describe the layer's packages.
(string) --
list
A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
(dict) --
Describes an Amazon EBS volume configuration.
MountPoint (string) -- [REQUIRED]
The volume mount point. For example "/dev/sdh".
RaidLevel (integer) --
The volume RAID level.
NumberOfDisks (integer) -- [REQUIRED]
The number of disks in the volume.
Size (integer) -- [REQUIRED]
The volume size.
VolumeType (string) --
The volume type. For more information, see Amazon EBS Volume Types.
standard - Magnetic
io1 - Provisioned IOPS (SSD)
gp2 - General Purpose (SSD)
st1 - Throughput Optimized hard disk drive (HDD)
sc1 - Cold HDD
Iops (integer) --
For PIOPS volumes, the IOPS per disk.
Encrypted (boolean) --
Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
boolean
Whether to disable auto healing for the layer.
boolean
Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
boolean
For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.
dict
A LayerCustomRecipes object that specifies the layer's custom recipes.
Setup (list) --
An array of custom recipe names to be run following a setup event.
(string) --
Configure (list) --
An array of custom recipe names to be run following a configure event.
(string) --
Deploy (list) --
An array of custom recipe names to be run following a deploy event.
(string) --
Undeploy (list) --
An array of custom recipe names to be run following a undeploy event.
(string) --
Shutdown (list) --
An array of custom recipe names to be run following a shutdown event.
(string) --
boolean
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 manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
Note
We strongly recommend using the default value of true , to ensure that your instances have the latest security updates.
boolean
Whether to use Amazon EBS-optimized instances.
dict
Shutdown (dict) --
A ShutdownEventConfiguration object that specifies the Shutdown event configuration.
ExecutionTimeout (integer) --
The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a Shutdown event before shutting down an instance.
DelayUntilElbConnectionsDrained (boolean) --
Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining
None