2019/12/18 - AWS OpsWorks CM - 3 new 2 updated api methods
Changes AWS OpsWorks CM now supports tagging, and tag-based access control, of servers and backups.
Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or backups.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceArn='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Resource Number (ARN) of an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server for which you want to show applied tags. For example, arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE .
string
NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call ListTagsForResource again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null . Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.
integer
To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Tags (list) --
Tags that have been applied to the resource.
(dict) --
A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server. Leading and trailing white spaces are trimmed from both the key and value. A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.
Key (string) --
A tag key, such as Stage or Name . A tag key cannot be empty. The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
Value (string) --
An optional tag value, such as Production or test-owcm-server . The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
NextToken (string) --
A token that you can use as the value of NextToken in subsequent calls to the API to show more results.
Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Number (ARN) of a resource to which you want to apply tags. For example, arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE .
list
[REQUIRED]
A map that contains tag keys and tag values to attach to AWS OpsWorks-CM servers or backups.
The key cannot be empty.
The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
Leading and trailing white spaces are trimmed from both the key and value.
A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server or backup.
(dict) --
A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server. Leading and trailing white spaces are trimmed from both the key and value. A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.
Key (string) -- [REQUIRED]
A tag key, such as Stage or Name . A tag key cannot be empty. The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
Value (string) -- [REQUIRED]
An optional tag value, such as Production or test-owcm-server . The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
dict
Response Syntax
{}
Response Structure
(dict) --
Removes specified tags from an AWS OpsWorks-CM server or backup.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Number (ARN) of a resource from which you want to remove tags. For example, arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE .
list
[REQUIRED]
The keys of tags that you want to remove.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Creates an application-level backup of a server. While the server is in the BACKING_UP state, the server cannot be changed, and no additional backup can be created.
Backups can be created for servers in RUNNING , HEALTHY , and UNHEALTHY states. By default, you can create a maximum of 50 manual backups.
This operation is asynchronous.
A LimitExceededException is thrown when the maximum number of manual backups is reached. An InvalidStateException is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or UNHEALTHY. A ResourceNotFoundException is thrown when the server is not found. A ValidationException is thrown when parameters of the request are not valid.
See also: AWS API Documentation
Request Syntax
client.create_backup(
ServerName='string',
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the server that you want to back up.
string
A user-defined description of the backup.
list
A map that contains tag keys and tag values to attach to an AWS OpsWorks-CM server backup.
The key cannot be empty.
The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
Leading and trailing white spaces are trimmed from both the key and value.
A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.
(dict) --
A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server. Leading and trailing white spaces are trimmed from both the key and value. A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.
Key (string) -- [REQUIRED]
A tag key, such as Stage or Name . A tag key cannot be empty. The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
Value (string) -- [REQUIRED]
An optional tag value, such as Production or test-owcm-server . The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
dict
Response Syntax
{
'Backup': {
'BackupArn': 'string',
'BackupId': 'string',
'BackupType': 'AUTOMATED'|'MANUAL',
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'Engine': 'string',
'EngineModel': 'string',
'EngineVersion': 'string',
'InstanceProfileArn': 'string',
'InstanceType': 'string',
'KeyPair': 'string',
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'S3DataSize': 123,
'S3DataUrl': 'string',
'S3LogUrl': 'string',
'SecurityGroupIds': [
'string',
],
'ServerName': 'string',
'ServiceRoleArn': 'string',
'Status': 'IN_PROGRESS'|'OK'|'FAILED'|'DELETING',
'StatusDescription': 'string',
'SubnetIds': [
'string',
],
'ToolsVersion': 'string',
'UserArn': 'string'
}
}
Response Structure
(dict) --
Backup (dict) --
Backup created by request.
BackupArn (string) --
The ARN of the backup.
BackupId (string) --
The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS
BackupType (string) --
The backup type. Valid values are automated or manual .
CreatedAt (datetime) --
The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z
Description (string) --
A user-provided description for a manual backup. This field is empty for automated backups.
Engine (string) --
The engine type that is obtained from the server when the backup is created.
EngineModel (string) --
The engine model that is obtained from the server when the backup is created.
EngineVersion (string) --
The engine version that is obtained from the server when the backup is created.
InstanceProfileArn (string) --
The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup.
InstanceType (string) --
The instance type that is obtained from the server when the backup is created.
KeyPair (string) --
The key pair that is obtained from the server when the backup is created.
PreferredBackupWindow (string) --
The preferred backup period that is obtained from the server when the backup is created.
PreferredMaintenanceWindow (string) --
The preferred maintenance period that is obtained from the server when the backup is created.
S3DataSize (integer) --
This field is deprecated and is no longer used.
S3DataUrl (string) --
This field is deprecated and is no longer used.
S3LogUrl (string) --
The Amazon S3 URL of the backup's log file.
SecurityGroupIds (list) --
The security group IDs that are obtained from the server when the backup is created.
(string) --
ServerName (string) --
The name of the server from which the backup was made.
ServiceRoleArn (string) --
The service role ARN that is obtained from the server when the backup is created.
Status (string) --
The status of a backup while in progress.
StatusDescription (string) --
An informational message about backup status.
SubnetIds (list) --
The subnet IDs that are obtained from the server when the backup is created.
(string) --
ToolsVersion (string) --
The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.
UserArn (string) --
The IAM user ARN of the requester for manual backups. This field is empty for automated backups.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Creates and immedately starts a new server. The server is ready to use when it is in the HEALTHY state. By default, you can create a maximum of 10 servers.
This operation is asynchronous.
A LimitExceededException is thrown when you have created the maximum number of servers (10). A ResourceAlreadyExistsException is thrown when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when you specify a backup ID that is not valid or is for a backup that does not exist. A ValidationException is thrown when parameters of the request are not valid.
If you do not specify a security group by adding the SecurityGroupIds parameter, AWS OpsWorks creates a new security group.
Chef Automate: The default security group opens the Chef server to the world on TCP port 443. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.
Puppet Enterprise: The default security group opens TCP ports 22, 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.
By default, your server is accessible from any IP address. We recommend that you update your security group rules to allow access from known IP addresses and address ranges only. To edit security group rules, open Security Groups in the navigation pane of the EC2 management console.
To specify your own domain for a server, and provide your own self-signed or CA-signed certificate and private key, specify values for CustomDomain , CustomCertificate , and CustomPrivateKey .
See also: AWS API Documentation
Request Syntax
client.create_server(
AssociatePublicIpAddress=True|False,
CustomDomain='string',
CustomCertificate='string',
CustomPrivateKey='string',
DisableAutomatedBackup=True|False,
Engine='string',
EngineModel='string',
EngineVersion='string',
EngineAttributes=[
{
'Name': 'string',
'Value': 'string'
},
],
BackupRetentionCount=123,
ServerName='string',
InstanceProfileArn='string',
InstanceType='string',
KeyPair='string',
PreferredMaintenanceWindow='string',
PreferredBackupWindow='string',
SecurityGroupIds=[
'string',
],
ServiceRoleArn='string',
SubnetIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
BackupId='string'
)
boolean
Associate a public IP address with a server that you are launching. Valid values are true or false . The default value is true .
string
Supported on servers running Chef Automate 2. An optional public endpoint of a server, such as https://aws.my-company.com . To access the server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the generated Endpoint value if the server is using a custom domain. If you specify a custom domain, you must also specify values for CustomCertificate and CustomPrivateKey .
string
Supported on servers running Chef Automate 2. A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a custom certificate, you must also specify values for CustomDomain and CustomPrivateKey . The following are requirements for the CustomCertificate value:
You can provide either a self-signed, custom certificate, or the full certificate chain.
The certificate must be a valid X509 certificate, or a certificate chain in PEM format.
The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's NotBefore date), or after it expires (the certificate's NotAfter date).
The certificate’s common name or subject alternative names (SANs), if present, must match the value of CustomDomain .
The certificate must match the value of CustomPrivateKey .
string
Supported on servers running Chef Automate 2. A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify values for CustomDomain and CustomCertificate .
boolean
Enable or disable scheduled backups. Valid values are true or false . The default value is true .
string
The configuration management engine to use. Valid values include ChefAutomate and Puppet .
string
The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.
string
The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 12 . For a Puppet server, the valid value is 2017 .
list
Optional engine attributes on a specified server.
Attributes accepted in a Chef createServer request:
CHEF_AUTOMATE_PIVOTAL_KEY : A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and returned in the response.
CHEF_AUTOMATE_ADMIN_PASSWORD : The password for the administrative user in the Chef Automate web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response.
Attributes accepted in a Puppet createServer request:
PUPPET_ADMIN_PASSWORD : To work with the Puppet Enterprise console, a password must use ASCII characters.
PUPPET_R10K_REMOTE : The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
PUPPET_R10K_PRIVATE_KEY : If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.
(dict) --
A name and value pair that is specific to the engine of the server.
Name (string) --
The name of the engine attribute.
Value (string) --
The value of the engine attribute.
integer
The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1 .
string
[REQUIRED]
The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.
string
[REQUIRED]
The ARN of the instance profile that your Amazon EC2 instances use. Although the AWS OpsWorks console typically creates the instance profile for you, if you are using API commands instead, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the instance profile you need.
string
[REQUIRED]
The Amazon EC2 instance type to use. For example, m5.large .
string
The Amazon EC2 key pair to set for the instance. This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH.
string
The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance. Valid values must be specified in the following format: DDD:HH:MM . The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information.
Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)
string
The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled. Valid values must be specified in one of the following formats:
HH:MM for daily backups
DDD:HH:MM for weekly backups
The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.
Example: 08:00 , which represents a daily start time of 08:00 UTC.
Example: Mon:08:00 , which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)
list
A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified security groups must be within the VPC that is specified by SubnetIds .
If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).
(string) --
string
[REQUIRED]
The service role that the AWS OpsWorks CM service backend uses to work with your account. Although the AWS OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or API commands, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role and instance profile that you need.
list
The IDs of subnets in which to launch the server EC2 instance.
Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled.
EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled.
For more information about supported Amazon EC2 platforms, see Supported Platforms.
(string) --
list
A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server.
The key cannot be empty.
The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
Leading and trailing white spaces are trimmed from both the key and value.
A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server.
(dict) --
A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server. Leading and trailing white spaces are trimmed from both the key and value. A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.
Key (string) -- [REQUIRED]
A tag key, such as Stage or Name . A tag key cannot be empty. The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
Value (string) -- [REQUIRED]
An optional tag value, such as Production or test-owcm-server . The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
string
If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
dict
Response Syntax
{
'Server': {
'AssociatePublicIpAddress': True|False,
'BackupRetentionCount': 123,
'ServerName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'CloudFormationStackArn': 'string',
'CustomDomain': 'string',
'DisableAutomatedBackup': True|False,
'Endpoint': 'string',
'Engine': 'string',
'EngineModel': 'string',
'EngineAttributes': [
{
'Name': 'string',
'Value': 'string'
},
],
'EngineVersion': 'string',
'InstanceProfileArn': 'string',
'InstanceType': 'string',
'KeyPair': 'string',
'MaintenanceStatus': 'SUCCESS'|'FAILED',
'PreferredMaintenanceWindow': 'string',
'PreferredBackupWindow': 'string',
'SecurityGroupIds': [
'string',
],
'ServiceRoleArn': 'string',
'Status': 'BACKING_UP'|'CONNECTION_LOST'|'CREATING'|'DELETING'|'MODIFYING'|'FAILED'|'HEALTHY'|'RUNNING'|'RESTORING'|'SETUP'|'UNDER_MAINTENANCE'|'UNHEALTHY'|'TERMINATED',
'StatusReason': 'string',
'SubnetIds': [
'string',
],
'ServerArn': 'string'
}
}
Response Structure
(dict) --
Server (dict) --
The server that is created by the request.
AssociatePublicIpAddress (boolean) --
Associate a public IP address with a server that you are launching.
BackupRetentionCount (integer) --
The number of automated backups to keep.
ServerName (string) --
The name of the server.
CreatedAt (datetime) --
Time stamp of server creation. Example 2016-07-29T13:38:47.520Z
CloudFormationStackArn (string) --
The ARN of the CloudFormation stack that was used to create the server.
CustomDomain (string) --
An optional public endpoint of a server, such as https://aws.my-company.com . You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.
DisableAutomatedBackup (boolean) --
Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
Endpoint (string) --
A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io . You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.
Engine (string) --
The engine type of the server. Valid values in this release include ChefAutomate and Puppet .
EngineModel (string) --
The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.
EngineAttributes (list) --
The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer().
Attributes returned in a createServer response for Chef
CHEF_AUTOMATE_PIVOTAL_KEY : A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.
CHEF_STARTER_KIT : A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.
Attributes returned in a createServer response for Puppet
PUPPET_STARTER_KIT : A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents.
PUPPET_ADMIN_PASSWORD : An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.
(dict) --
A name and value pair that is specific to the engine of the server.
Name (string) --
The name of the engine attribute.
Value (string) --
The value of the engine attribute.
EngineVersion (string) --
The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 12 . For a Puppet server, the valid value is 2017 .
InstanceProfileArn (string) --
The instance profile ARN of the server.
InstanceType (string) --
The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.
KeyPair (string) --
The key pair associated with the server.
MaintenanceStatus (string) --
The status of the most recent server maintenance run. Shows SUCCESS or FAILED .
PreferredMaintenanceWindow (string) --
The preferred maintenance period specified for the server.
PreferredBackupWindow (string) --
The preferred backup period specified for the server.
SecurityGroupIds (list) --
The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.
(string) --
ServiceRoleArn (string) --
The service role ARN used to create the server.
Status (string) --
The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state.
StatusReason (string) --
Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).
SubnetIds (list) --
The subnet IDs specified in a CreateServer request.
(string) --
ServerArn (string) --
The ARN of the server.