AWS SDK for C++  1.9.15
AWS SDK for C++
Public Member Functions | List of all members
Aws::OpsWorksCM::Model::CreateServerRequest Class Reference

#include <CreateServerRequest.h>

+ Inheritance diagram for Aws::OpsWorksCM::Model::CreateServerRequest:

Public Member Functions

 CreateServerRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
bool GetAssociatePublicIpAddress () const
 
bool AssociatePublicIpAddressHasBeenSet () const
 
void SetAssociatePublicIpAddress (bool value)
 
CreateServerRequestWithAssociatePublicIpAddress (bool value)
 
const Aws::StringGetCustomDomain () const
 
bool CustomDomainHasBeenSet () const
 
void SetCustomDomain (const Aws::String &value)
 
void SetCustomDomain (Aws::String &&value)
 
void SetCustomDomain (const char *value)
 
CreateServerRequestWithCustomDomain (const Aws::String &value)
 
CreateServerRequestWithCustomDomain (Aws::String &&value)
 
CreateServerRequestWithCustomDomain (const char *value)
 
const Aws::StringGetCustomCertificate () const
 
bool CustomCertificateHasBeenSet () const
 
void SetCustomCertificate (const Aws::String &value)
 
void SetCustomCertificate (Aws::String &&value)
 
void SetCustomCertificate (const char *value)
 
CreateServerRequestWithCustomCertificate (const Aws::String &value)
 
CreateServerRequestWithCustomCertificate (Aws::String &&value)
 
CreateServerRequestWithCustomCertificate (const char *value)
 
const Aws::StringGetCustomPrivateKey () const
 
bool CustomPrivateKeyHasBeenSet () const
 
void SetCustomPrivateKey (const Aws::String &value)
 
void SetCustomPrivateKey (Aws::String &&value)
 
void SetCustomPrivateKey (const char *value)
 
CreateServerRequestWithCustomPrivateKey (const Aws::String &value)
 
CreateServerRequestWithCustomPrivateKey (Aws::String &&value)
 
CreateServerRequestWithCustomPrivateKey (const char *value)
 
bool GetDisableAutomatedBackup () const
 
bool DisableAutomatedBackupHasBeenSet () const
 
void SetDisableAutomatedBackup (bool value)
 
CreateServerRequestWithDisableAutomatedBackup (bool value)
 
const Aws::StringGetEngine () const
 
bool EngineHasBeenSet () const
 
void SetEngine (const Aws::String &value)
 
void SetEngine (Aws::String &&value)
 
void SetEngine (const char *value)
 
CreateServerRequestWithEngine (const Aws::String &value)
 
CreateServerRequestWithEngine (Aws::String &&value)
 
CreateServerRequestWithEngine (const char *value)
 
const Aws::StringGetEngineModel () const
 
bool EngineModelHasBeenSet () const
 
void SetEngineModel (const Aws::String &value)
 
void SetEngineModel (Aws::String &&value)
 
void SetEngineModel (const char *value)
 
CreateServerRequestWithEngineModel (const Aws::String &value)
 
CreateServerRequestWithEngineModel (Aws::String &&value)
 
CreateServerRequestWithEngineModel (const char *value)
 
const Aws::StringGetEngineVersion () const
 
bool EngineVersionHasBeenSet () const
 
void SetEngineVersion (const Aws::String &value)
 
void SetEngineVersion (Aws::String &&value)
 
void SetEngineVersion (const char *value)
 
CreateServerRequestWithEngineVersion (const Aws::String &value)
 
CreateServerRequestWithEngineVersion (Aws::String &&value)
 
CreateServerRequestWithEngineVersion (const char *value)
 
const Aws::Vector< EngineAttribute > & GetEngineAttributes () const
 
bool EngineAttributesHasBeenSet () const
 
void SetEngineAttributes (const Aws::Vector< EngineAttribute > &value)
 
void SetEngineAttributes (Aws::Vector< EngineAttribute > &&value)
 
CreateServerRequestWithEngineAttributes (const Aws::Vector< EngineAttribute > &value)
 
CreateServerRequestWithEngineAttributes (Aws::Vector< EngineAttribute > &&value)
 
CreateServerRequestAddEngineAttributes (const EngineAttribute &value)
 
CreateServerRequestAddEngineAttributes (EngineAttribute &&value)
 
int GetBackupRetentionCount () const
 
bool BackupRetentionCountHasBeenSet () const
 
void SetBackupRetentionCount (int value)
 
CreateServerRequestWithBackupRetentionCount (int value)
 
const Aws::StringGetServerName () const
 
bool ServerNameHasBeenSet () const
 
void SetServerName (const Aws::String &value)
 
void SetServerName (Aws::String &&value)
 
void SetServerName (const char *value)
 
CreateServerRequestWithServerName (const Aws::String &value)
 
CreateServerRequestWithServerName (Aws::String &&value)
 
CreateServerRequestWithServerName (const char *value)
 
const Aws::StringGetInstanceProfileArn () const
 
bool InstanceProfileArnHasBeenSet () const
 
void SetInstanceProfileArn (const Aws::String &value)
 
void SetInstanceProfileArn (Aws::String &&value)
 
void SetInstanceProfileArn (const char *value)
 
CreateServerRequestWithInstanceProfileArn (const Aws::String &value)
 
CreateServerRequestWithInstanceProfileArn (Aws::String &&value)
 
CreateServerRequestWithInstanceProfileArn (const char *value)
 
const Aws::StringGetInstanceType () const
 
bool InstanceTypeHasBeenSet () const
 
void SetInstanceType (const Aws::String &value)
 
void SetInstanceType (Aws::String &&value)
 
void SetInstanceType (const char *value)
 
CreateServerRequestWithInstanceType (const Aws::String &value)
 
CreateServerRequestWithInstanceType (Aws::String &&value)
 
CreateServerRequestWithInstanceType (const char *value)
 
const Aws::StringGetKeyPair () const
 
bool KeyPairHasBeenSet () const
 
void SetKeyPair (const Aws::String &value)
 
void SetKeyPair (Aws::String &&value)
 
void SetKeyPair (const char *value)
 
CreateServerRequestWithKeyPair (const Aws::String &value)
 
CreateServerRequestWithKeyPair (Aws::String &&value)
 
CreateServerRequestWithKeyPair (const char *value)
 
const Aws::StringGetPreferredMaintenanceWindow () const
 
bool PreferredMaintenanceWindowHasBeenSet () const
 
void SetPreferredMaintenanceWindow (const Aws::String &value)
 
void SetPreferredMaintenanceWindow (Aws::String &&value)
 
void SetPreferredMaintenanceWindow (const char *value)
 
CreateServerRequestWithPreferredMaintenanceWindow (const Aws::String &value)
 
CreateServerRequestWithPreferredMaintenanceWindow (Aws::String &&value)
 
CreateServerRequestWithPreferredMaintenanceWindow (const char *value)
 
const Aws::StringGetPreferredBackupWindow () const
 
bool PreferredBackupWindowHasBeenSet () const
 
void SetPreferredBackupWindow (const Aws::String &value)
 
void SetPreferredBackupWindow (Aws::String &&value)
 
void SetPreferredBackupWindow (const char *value)
 
CreateServerRequestWithPreferredBackupWindow (const Aws::String &value)
 
CreateServerRequestWithPreferredBackupWindow (Aws::String &&value)
 
CreateServerRequestWithPreferredBackupWindow (const char *value)
 
const Aws::Vector< Aws::String > & GetSecurityGroupIds () const
 
bool SecurityGroupIdsHasBeenSet () const
 
void SetSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
void SetSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
CreateServerRequestWithSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
CreateServerRequestWithSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
CreateServerRequestAddSecurityGroupIds (const Aws::String &value)
 
CreateServerRequestAddSecurityGroupIds (Aws::String &&value)
 
CreateServerRequestAddSecurityGroupIds (const char *value)
 
const Aws::StringGetServiceRoleArn () const
 
bool ServiceRoleArnHasBeenSet () const
 
void SetServiceRoleArn (const Aws::String &value)
 
void SetServiceRoleArn (Aws::String &&value)
 
void SetServiceRoleArn (const char *value)
 
CreateServerRequestWithServiceRoleArn (const Aws::String &value)
 
CreateServerRequestWithServiceRoleArn (Aws::String &&value)
 
CreateServerRequestWithServiceRoleArn (const char *value)
 
const Aws::Vector< Aws::String > & GetSubnetIds () const
 
bool SubnetIdsHasBeenSet () const
 
void SetSubnetIds (const Aws::Vector< Aws::String > &value)
 
void SetSubnetIds (Aws::Vector< Aws::String > &&value)
 
CreateServerRequestWithSubnetIds (const Aws::Vector< Aws::String > &value)
 
CreateServerRequestWithSubnetIds (Aws::Vector< Aws::String > &&value)
 
CreateServerRequestAddSubnetIds (const Aws::String &value)
 
CreateServerRequestAddSubnetIds (Aws::String &&value)
 
CreateServerRequestAddSubnetIds (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateServerRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateServerRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateServerRequestAddTags (const Tag &value)
 
CreateServerRequestAddTags (Tag &&value)
 
const Aws::StringGetBackupId () const
 
bool BackupIdHasBeenSet () const
 
void SetBackupId (const Aws::String &value)
 
void SetBackupId (Aws::String &&value)
 
void SetBackupId (const char *value)
 
CreateServerRequestWithBackupId (const Aws::String &value)
 
CreateServerRequestWithBackupId (Aws::String &&value)
 
CreateServerRequestWithBackupId (const char *value)
 
- Public Member Functions inherited from Aws::OpsWorksCM::OpsWorksCMRequest
virtual ~OpsWorksCMRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 24 of file CreateServerRequest.h.

Constructor & Destructor Documentation

◆ CreateServerRequest()

Aws::OpsWorksCM::Model::CreateServerRequest::CreateServerRequest ( )

Member Function Documentation

◆ AddEngineAttributes() [1/2]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::AddEngineAttributes ( const EngineAttribute value)
inline

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.

Definition at line 729 of file CreateServerRequest.h.

◆ AddEngineAttributes() [2/2]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::AddEngineAttributes ( EngineAttribute &&  value)
inline

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.

Definition at line 754 of file CreateServerRequest.h.

◆ AddSecurityGroupIds() [1/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::AddSecurityGroupIds ( Aws::String &&  value)
inline

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).

Definition at line 1326 of file CreateServerRequest.h.

◆ AddSecurityGroupIds() [2/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::AddSecurityGroupIds ( const Aws::String value)
inline

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).

Definition at line 1317 of file CreateServerRequest.h.

◆ AddSecurityGroupIds() [3/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::AddSecurityGroupIds ( const char *  value)
inline

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).

Definition at line 1335 of file CreateServerRequest.h.

◆ AddSubnetIds() [1/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::AddSubnetIds ( Aws::String &&  value)
inline

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.

Definition at line 1537 of file CreateServerRequest.h.

◆ AddSubnetIds() [2/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::AddSubnetIds ( const Aws::String value)
inline

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.

Definition at line 1523 of file CreateServerRequest.h.

◆ AddSubnetIds() [3/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::AddSubnetIds ( const char *  value)
inline

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.

Definition at line 1551 of file CreateServerRequest.h.

◆ AddTags() [1/2]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::AddTags ( const Tag value)
inline

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: + - = . _ : / </code>

  • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / </code>

  • 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.

Definition at line 1650 of file CreateServerRequest.h.

◆ AddTags() [2/2]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::AddTags ( Tag &&  value)
inline

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: + - = . _ : / </code>

  • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / </code>

  • 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.

Definition at line 1664 of file CreateServerRequest.h.

◆ AssociatePublicIpAddressHasBeenSet()

bool Aws::OpsWorksCM::Model::CreateServerRequest::AssociatePublicIpAddressHasBeenSet ( ) const
inline

Associate a public IP address with a server that you are launching. Valid values are true or false. The default value is true.

Definition at line 52 of file CreateServerRequest.h.

◆ BackupIdHasBeenSet()

bool Aws::OpsWorksCM::Model::CreateServerRequest::BackupIdHasBeenSet ( ) const
inline

If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.

Definition at line 1677 of file CreateServerRequest.h.

◆ BackupRetentionCountHasBeenSet()

bool Aws::OpsWorksCM::Model::CreateServerRequest::BackupRetentionCountHasBeenSet ( ) const
inline

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.

Definition at line 769 of file CreateServerRequest.h.

◆ CustomCertificateHasBeenSet()

bool Aws::OpsWorksCM::Model::CreateServerRequest::CustomCertificateHasBeenSet ( ) const
inline

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.

Definition at line 200 of file CreateServerRequest.h.

◆ CustomDomainHasBeenSet()

bool Aws::OpsWorksCM::Model::CreateServerRequest::CustomDomainHasBeenSet ( ) const
inline

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.

Definition at line 91 of file CreateServerRequest.h.

◆ CustomPrivateKeyHasBeenSet()

bool Aws::OpsWorksCM::Model::CreateServerRequest::CustomPrivateKeyHasBeenSet ( ) const
inline

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.

Definition at line 325 of file CreateServerRequest.h.

◆ DisableAutomatedBackupHasBeenSet()

bool Aws::OpsWorksCM::Model::CreateServerRequest::DisableAutomatedBackupHasBeenSet ( ) const
inline

Enable or disable scheduled backups. Valid values are true or false. The default value is true.

Definition at line 386 of file CreateServerRequest.h.

◆ EngineAttributesHasBeenSet()

bool Aws::OpsWorksCM::Model::CreateServerRequest::EngineAttributesHasBeenSet ( ) const
inline

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.

Definition at line 604 of file CreateServerRequest.h.

◆ EngineHasBeenSet()

bool Aws::OpsWorksCM::Model::CreateServerRequest::EngineHasBeenSet ( ) const
inline

The configuration management engine to use. Valid values include ChefAutomate and Puppet.

Definition at line 411 of file CreateServerRequest.h.

◆ EngineModelHasBeenSet()

bool Aws::OpsWorksCM::Model::CreateServerRequest::EngineModelHasBeenSet ( ) const
inline

The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

Definition at line 460 of file CreateServerRequest.h.

◆ EngineVersionHasBeenSet()

bool Aws::OpsWorksCM::Model::CreateServerRequest::EngineVersionHasBeenSet ( ) const
inline

The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, the valid value is 2017.

Definition at line 511 of file CreateServerRequest.h.

◆ GetAssociatePublicIpAddress()

bool Aws::OpsWorksCM::Model::CreateServerRequest::GetAssociatePublicIpAddress ( ) const
inline

Associate a public IP address with a server that you are launching. Valid values are true or false. The default value is true.

Definition at line 45 of file CreateServerRequest.h.

◆ GetBackupId()

const Aws::String& Aws::OpsWorksCM::Model::CreateServerRequest::GetBackupId ( ) const
inline

If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.

Definition at line 1671 of file CreateServerRequest.h.

◆ GetBackupRetentionCount()

int Aws::OpsWorksCM::Model::CreateServerRequest::GetBackupRetentionCount ( ) const
inline

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.

Definition at line 762 of file CreateServerRequest.h.

◆ GetCustomCertificate()

const Aws::String& Aws::OpsWorksCM::Model::CreateServerRequest::GetCustomCertificate ( ) const
inline

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.

Definition at line 182 of file CreateServerRequest.h.

◆ GetCustomDomain()

const Aws::String& Aws::OpsWorksCM::Model::CreateServerRequest::GetCustomDomain ( ) const
inline

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.

Definition at line 79 of file CreateServerRequest.h.

◆ GetCustomPrivateKey()

const Aws::String& Aws::OpsWorksCM::Model::CreateServerRequest::GetCustomPrivateKey ( ) const
inline

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.

Definition at line 317 of file CreateServerRequest.h.

◆ GetDisableAutomatedBackup()

bool Aws::OpsWorksCM::Model::CreateServerRequest::GetDisableAutomatedBackup ( ) const
inline

Enable or disable scheduled backups. Valid values are true or false. The default value is true.

Definition at line 380 of file CreateServerRequest.h.

◆ GetEngine()

const Aws::String& Aws::OpsWorksCM::Model::CreateServerRequest::GetEngine ( ) const
inline

The configuration management engine to use. Valid values include ChefAutomate and Puppet.

Definition at line 405 of file CreateServerRequest.h.

◆ GetEngineAttributes()

const Aws::Vector<EngineAttribute>& Aws::OpsWorksCM::Model::CreateServerRequest::GetEngineAttributes ( ) const
inline

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.

Definition at line 579 of file CreateServerRequest.h.

◆ GetEngineModel()

const Aws::String& Aws::OpsWorksCM::Model::CreateServerRequest::GetEngineModel ( ) const
inline

The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

Definition at line 454 of file CreateServerRequest.h.

◆ GetEngineVersion()

const Aws::String& Aws::OpsWorksCM::Model::CreateServerRequest::GetEngineVersion ( ) const
inline

The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, the valid value is 2017.

Definition at line 504 of file CreateServerRequest.h.

◆ GetInstanceProfileArn()

const Aws::String& Aws::OpsWorksCM::Model::CreateServerRequest::GetInstanceProfileArn ( ) const
inline

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.

Definition at line 860 of file CreateServerRequest.h.

◆ GetInstanceType()

const Aws::String& Aws::OpsWorksCM::Model::CreateServerRequest::GetInstanceType ( ) const
inline

The Amazon EC2 instance type to use. For example, m5.large.

Definition at line 944 of file CreateServerRequest.h.

◆ GetKeyPair()

const Aws::String& Aws::OpsWorksCM::Model::CreateServerRequest::GetKeyPair ( ) const
inline

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.

Definition at line 994 of file CreateServerRequest.h.

◆ GetPreferredBackupWindow()

const Aws::String& Aws::OpsWorksCM::Model::CreateServerRequest::GetPreferredBackupWindow ( ) const
inline

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

MM must be specified as 00. 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.)

Definition at line 1155 of file CreateServerRequest.h.

◆ GetPreferredMaintenanceWindow()

const Aws::String& Aws::OpsWorksCM::Model::CreateServerRequest::GetPreferredMaintenanceWindow ( ) const
inline

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. MM must be specified as 00. 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.)

Definition at line 1056 of file CreateServerRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::OpsWorksCM::Model::CreateServerRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetSecurityGroupIds()

const Aws::Vector<Aws::String>& Aws::OpsWorksCM::Model::CreateServerRequest::GetSecurityGroupIds ( ) const
inline

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).

Definition at line 1263 of file CreateServerRequest.h.

◆ GetServerName()

const Aws::String& Aws::OpsWorksCM::Model::CreateServerRequest::GetServerName ( ) const
inline

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.

Definition at line 792 of file CreateServerRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::OpsWorksCM::Model::CreateServerRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file CreateServerRequest.h.

◆ GetServiceRoleArn()

const Aws::String& Aws::OpsWorksCM::Model::CreateServerRequest::GetServiceRoleArn ( ) const
inline

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.

Definition at line 1347 of file CreateServerRequest.h.

◆ GetSubnetIds()

const Aws::Vector<Aws::String>& Aws::OpsWorksCM::Model::CreateServerRequest::GetSubnetIds ( ) const
inline

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.

Definition at line 1439 of file CreateServerRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::OpsWorksCM::Model::CreateServerRequest::GetTags ( ) const
inline

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: + - = . _ : / </code>

  • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / </code>

  • 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.

Definition at line 1566 of file CreateServerRequest.h.

◆ InstanceProfileArnHasBeenSet()

bool Aws::OpsWorksCM::Model::CreateServerRequest::InstanceProfileArnHasBeenSet ( ) const
inline

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.

Definition at line 871 of file CreateServerRequest.h.

◆ InstanceTypeHasBeenSet()

bool Aws::OpsWorksCM::Model::CreateServerRequest::InstanceTypeHasBeenSet ( ) const
inline

The Amazon EC2 instance type to use. For example, m5.large.

Definition at line 950 of file CreateServerRequest.h.

◆ KeyPairHasBeenSet()

bool Aws::OpsWorksCM::Model::CreateServerRequest::KeyPairHasBeenSet ( ) const
inline

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.

Definition at line 1001 of file CreateServerRequest.h.

◆ PreferredBackupWindowHasBeenSet()

bool Aws::OpsWorksCM::Model::CreateServerRequest::PreferredBackupWindowHasBeenSet ( ) const
inline

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

MM must be specified as 00. 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.)

Definition at line 1169 of file CreateServerRequest.h.

◆ PreferredMaintenanceWindowHasBeenSet()

bool Aws::OpsWorksCM::Model::CreateServerRequest::PreferredMaintenanceWindowHasBeenSet ( ) const
inline

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. MM must be specified as 00. 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.)

Definition at line 1068 of file CreateServerRequest.h.

◆ SecurityGroupIdsHasBeenSet()

bool Aws::OpsWorksCM::Model::CreateServerRequest::SecurityGroupIdsHasBeenSet ( ) const
inline

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).

Definition at line 1272 of file CreateServerRequest.h.

◆ SerializePayload()

Aws::String Aws::OpsWorksCM::Model::CreateServerRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ ServerNameHasBeenSet()

bool Aws::OpsWorksCM::Model::CreateServerRequest::ServerNameHasBeenSet ( ) const
inline

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.

Definition at line 800 of file CreateServerRequest.h.

◆ ServiceRoleArnHasBeenSet()

bool Aws::OpsWorksCM::Model::CreateServerRequest::ServiceRoleArnHasBeenSet ( ) const
inline

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.

Definition at line 1358 of file CreateServerRequest.h.

◆ SetAssociatePublicIpAddress()

void Aws::OpsWorksCM::Model::CreateServerRequest::SetAssociatePublicIpAddress ( bool  value)
inline

Associate a public IP address with a server that you are launching. Valid values are true or false. The default value is true.

Definition at line 59 of file CreateServerRequest.h.

◆ SetBackupId() [1/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetBackupId ( Aws::String &&  value)
inline

If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.

Definition at line 1689 of file CreateServerRequest.h.

◆ SetBackupId() [2/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetBackupId ( const Aws::String value)
inline

If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.

Definition at line 1683 of file CreateServerRequest.h.

◆ SetBackupId() [3/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetBackupId ( const char *  value)
inline

If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.

Definition at line 1695 of file CreateServerRequest.h.

◆ SetBackupRetentionCount()

void Aws::OpsWorksCM::Model::CreateServerRequest::SetBackupRetentionCount ( int  value)
inline

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.

Definition at line 776 of file CreateServerRequest.h.

◆ SetCustomCertificate() [1/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetCustomCertificate ( Aws::String &&  value)
inline

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.

Definition at line 236 of file CreateServerRequest.h.

◆ SetCustomCertificate() [2/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetCustomCertificate ( const Aws::String value)
inline

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.

Definition at line 218 of file CreateServerRequest.h.

◆ SetCustomCertificate() [3/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetCustomCertificate ( const char *  value)
inline

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.

Definition at line 254 of file CreateServerRequest.h.

◆ SetCustomDomain() [1/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetCustomDomain ( Aws::String &&  value)
inline

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.

Definition at line 115 of file CreateServerRequest.h.

◆ SetCustomDomain() [2/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetCustomDomain ( const Aws::String value)
inline

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.

Definition at line 103 of file CreateServerRequest.h.

◆ SetCustomDomain() [3/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetCustomDomain ( const char *  value)
inline

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.

Definition at line 127 of file CreateServerRequest.h.

◆ SetCustomPrivateKey() [1/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetCustomPrivateKey ( Aws::String &&  value)
inline

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.

Definition at line 341 of file CreateServerRequest.h.

◆ SetCustomPrivateKey() [2/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetCustomPrivateKey ( const Aws::String value)
inline

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.

Definition at line 333 of file CreateServerRequest.h.

◆ SetCustomPrivateKey() [3/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetCustomPrivateKey ( const char *  value)
inline

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.

Definition at line 349 of file CreateServerRequest.h.

◆ SetDisableAutomatedBackup()

void Aws::OpsWorksCM::Model::CreateServerRequest::SetDisableAutomatedBackup ( bool  value)
inline

Enable or disable scheduled backups. Valid values are true or false. The default value is true.

Definition at line 392 of file CreateServerRequest.h.

◆ SetEngine() [1/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetEngine ( Aws::String &&  value)
inline

The configuration management engine to use. Valid values include ChefAutomate and Puppet.

Definition at line 423 of file CreateServerRequest.h.

◆ SetEngine() [2/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetEngine ( const Aws::String value)
inline

The configuration management engine to use. Valid values include ChefAutomate and Puppet.

Definition at line 417 of file CreateServerRequest.h.

◆ SetEngine() [3/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetEngine ( const char *  value)
inline

The configuration management engine to use. Valid values include ChefAutomate and Puppet.

Definition at line 429 of file CreateServerRequest.h.

◆ SetEngineAttributes() [1/2]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetEngineAttributes ( Aws::Vector< EngineAttribute > &&  value)
inline

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.

Definition at line 654 of file CreateServerRequest.h.

◆ SetEngineAttributes() [2/2]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetEngineAttributes ( const Aws::Vector< EngineAttribute > &  value)
inline

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.

Definition at line 629 of file CreateServerRequest.h.

◆ SetEngineModel() [1/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetEngineModel ( Aws::String &&  value)
inline

The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

Definition at line 472 of file CreateServerRequest.h.

◆ SetEngineModel() [2/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetEngineModel ( const Aws::String value)
inline

The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

Definition at line 466 of file CreateServerRequest.h.

◆ SetEngineModel() [3/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetEngineModel ( const char *  value)
inline

The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

Definition at line 478 of file CreateServerRequest.h.

◆ SetEngineVersion() [1/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetEngineVersion ( Aws::String &&  value)
inline

The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, the valid value is 2017.

Definition at line 525 of file CreateServerRequest.h.

◆ SetEngineVersion() [2/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetEngineVersion ( const Aws::String value)
inline

The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, the valid value is 2017.

Definition at line 518 of file CreateServerRequest.h.

◆ SetEngineVersion() [3/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetEngineVersion ( const char *  value)
inline

The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, the valid value is 2017.

Definition at line 532 of file CreateServerRequest.h.

◆ SetInstanceProfileArn() [1/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetInstanceProfileArn ( Aws::String &&  value)
inline

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.

Definition at line 893 of file CreateServerRequest.h.

◆ SetInstanceProfileArn() [2/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetInstanceProfileArn ( const Aws::String value)
inline

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.

Definition at line 882 of file CreateServerRequest.h.

◆ SetInstanceProfileArn() [3/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetInstanceProfileArn ( const char *  value)
inline

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.

Definition at line 904 of file CreateServerRequest.h.

◆ SetInstanceType() [1/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetInstanceType ( Aws::String &&  value)
inline

The Amazon EC2 instance type to use. For example, m5.large.

Definition at line 962 of file CreateServerRequest.h.

◆ SetInstanceType() [2/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetInstanceType ( const Aws::String value)
inline

The Amazon EC2 instance type to use. For example, m5.large.

Definition at line 956 of file CreateServerRequest.h.

◆ SetInstanceType() [3/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetInstanceType ( const char *  value)
inline

The Amazon EC2 instance type to use. For example, m5.large.

Definition at line 968 of file CreateServerRequest.h.

◆ SetKeyPair() [1/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetKeyPair ( Aws::String &&  value)
inline

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.

Definition at line 1015 of file CreateServerRequest.h.

◆ SetKeyPair() [2/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetKeyPair ( const Aws::String value)
inline

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.

Definition at line 1008 of file CreateServerRequest.h.

◆ SetKeyPair() [3/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetKeyPair ( const char *  value)
inline

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.

Definition at line 1022 of file CreateServerRequest.h.

◆ SetPreferredBackupWindow() [1/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetPreferredBackupWindow ( Aws::String &&  value)
inline

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

MM must be specified as 00. 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.)

Definition at line 1197 of file CreateServerRequest.h.

◆ SetPreferredBackupWindow() [2/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetPreferredBackupWindow ( const Aws::String value)
inline

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

MM must be specified as 00. 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.)

Definition at line 1183 of file CreateServerRequest.h.

◆ SetPreferredBackupWindow() [3/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetPreferredBackupWindow ( const char *  value)
inline

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

MM must be specified as 00. 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.)

Definition at line 1211 of file CreateServerRequest.h.

◆ SetPreferredMaintenanceWindow() [1/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetPreferredMaintenanceWindow ( Aws::String &&  value)
inline

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. MM must be specified as 00. 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.)

Definition at line 1092 of file CreateServerRequest.h.

◆ SetPreferredMaintenanceWindow() [2/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetPreferredMaintenanceWindow ( const Aws::String value)
inline

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. MM must be specified as 00. 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.)

Definition at line 1080 of file CreateServerRequest.h.

◆ SetPreferredMaintenanceWindow() [3/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetPreferredMaintenanceWindow ( const char *  value)
inline

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. MM must be specified as 00. 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.)

Definition at line 1104 of file CreateServerRequest.h.

◆ SetSecurityGroupIds() [1/2]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

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).

Definition at line 1290 of file CreateServerRequest.h.

◆ SetSecurityGroupIds() [2/2]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

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).

Definition at line 1281 of file CreateServerRequest.h.

◆ SetServerName() [1/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetServerName ( Aws::String &&  value)
inline

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.

Definition at line 816 of file CreateServerRequest.h.

◆ SetServerName() [2/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetServerName ( const Aws::String value)
inline

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.

Definition at line 808 of file CreateServerRequest.h.

◆ SetServerName() [3/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetServerName ( const char *  value)
inline

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.

Definition at line 824 of file CreateServerRequest.h.

◆ SetServiceRoleArn() [1/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetServiceRoleArn ( Aws::String &&  value)
inline

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.

Definition at line 1380 of file CreateServerRequest.h.

◆ SetServiceRoleArn() [2/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetServiceRoleArn ( const Aws::String value)
inline

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.

Definition at line 1369 of file CreateServerRequest.h.

◆ SetServiceRoleArn() [3/3]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetServiceRoleArn ( const char *  value)
inline

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.

Definition at line 1391 of file CreateServerRequest.h.

◆ SetSubnetIds() [1/2]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetSubnetIds ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 1481 of file CreateServerRequest.h.

◆ SetSubnetIds() [2/2]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetSubnetIds ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 1467 of file CreateServerRequest.h.

◆ SetTags() [1/2]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

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: + - = . _ : / </code>

  • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / </code>

  • 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.

Definition at line 1608 of file CreateServerRequest.h.

◆ SetTags() [2/2]

void Aws::OpsWorksCM::Model::CreateServerRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

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: + - = . _ : / </code>

  • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / </code>

  • 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.

Definition at line 1594 of file CreateServerRequest.h.

◆ SubnetIdsHasBeenSet()

bool Aws::OpsWorksCM::Model::CreateServerRequest::SubnetIdsHasBeenSet ( ) const
inline

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.

Definition at line 1453 of file CreateServerRequest.h.

◆ TagsHasBeenSet()

bool Aws::OpsWorksCM::Model::CreateServerRequest::TagsHasBeenSet ( ) const
inline

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: + - = . _ : / </code>

  • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / </code>

  • 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.

Definition at line 1580 of file CreateServerRequest.h.

◆ WithAssociatePublicIpAddress()

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithAssociatePublicIpAddress ( bool  value)
inline

Associate a public IP address with a server that you are launching. Valid values are true or false. The default value is true.

Definition at line 66 of file CreateServerRequest.h.

◆ WithBackupId() [1/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithBackupId ( Aws::String &&  value)
inline

If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.

Definition at line 1707 of file CreateServerRequest.h.

◆ WithBackupId() [2/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithBackupId ( const Aws::String value)
inline

If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.

Definition at line 1701 of file CreateServerRequest.h.

◆ WithBackupId() [3/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithBackupId ( const char *  value)
inline

If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.

Definition at line 1713 of file CreateServerRequest.h.

◆ WithBackupRetentionCount()

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithBackupRetentionCount ( int  value)
inline

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.

Definition at line 783 of file CreateServerRequest.h.

◆ WithCustomCertificate() [1/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithCustomCertificate ( Aws::String &&  value)
inline

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.

Definition at line 290 of file CreateServerRequest.h.

◆ WithCustomCertificate() [2/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithCustomCertificate ( const Aws::String value)
inline

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.

Definition at line 272 of file CreateServerRequest.h.

◆ WithCustomCertificate() [3/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithCustomCertificate ( const char *  value)
inline

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.

Definition at line 308 of file CreateServerRequest.h.

◆ WithCustomDomain() [1/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithCustomDomain ( Aws::String &&  value)
inline

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.

Definition at line 151 of file CreateServerRequest.h.

◆ WithCustomDomain() [2/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithCustomDomain ( const Aws::String value)
inline

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.

Definition at line 139 of file CreateServerRequest.h.

◆ WithCustomDomain() [3/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithCustomDomain ( const char *  value)
inline

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.

Definition at line 163 of file CreateServerRequest.h.

◆ WithCustomPrivateKey() [1/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithCustomPrivateKey ( Aws::String &&  value)
inline

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.

Definition at line 365 of file CreateServerRequest.h.

◆ WithCustomPrivateKey() [2/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithCustomPrivateKey ( const Aws::String value)
inline

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.

Definition at line 357 of file CreateServerRequest.h.

◆ WithCustomPrivateKey() [3/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithCustomPrivateKey ( const char *  value)
inline

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.

Definition at line 373 of file CreateServerRequest.h.

◆ WithDisableAutomatedBackup()

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithDisableAutomatedBackup ( bool  value)
inline

Enable or disable scheduled backups. Valid values are true or false. The default value is true.

Definition at line 398 of file CreateServerRequest.h.

◆ WithEngine() [1/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithEngine ( Aws::String &&  value)
inline

The configuration management engine to use. Valid values include ChefAutomate and Puppet.

Definition at line 441 of file CreateServerRequest.h.

◆ WithEngine() [2/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithEngine ( const Aws::String value)
inline

The configuration management engine to use. Valid values include ChefAutomate and Puppet.

Definition at line 435 of file CreateServerRequest.h.

◆ WithEngine() [3/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithEngine ( const char *  value)
inline

The configuration management engine to use. Valid values include ChefAutomate and Puppet.

Definition at line 447 of file CreateServerRequest.h.

◆ WithEngineAttributes() [1/2]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithEngineAttributes ( Aws::Vector< EngineAttribute > &&  value)
inline

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.

Definition at line 704 of file CreateServerRequest.h.

◆ WithEngineAttributes() [2/2]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithEngineAttributes ( const Aws::Vector< EngineAttribute > &  value)
inline

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.

Definition at line 679 of file CreateServerRequest.h.

◆ WithEngineModel() [1/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithEngineModel ( Aws::String &&  value)
inline

The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

Definition at line 490 of file CreateServerRequest.h.

◆ WithEngineModel() [2/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithEngineModel ( const Aws::String value)
inline

The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

Definition at line 484 of file CreateServerRequest.h.

◆ WithEngineModel() [3/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithEngineModel ( const char *  value)
inline

The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

Definition at line 496 of file CreateServerRequest.h.

◆ WithEngineVersion() [1/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithEngineVersion ( Aws::String &&  value)
inline

The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, the valid value is 2017.

Definition at line 546 of file CreateServerRequest.h.

◆ WithEngineVersion() [2/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithEngineVersion ( const Aws::String value)
inline

The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, the valid value is 2017.

Definition at line 539 of file CreateServerRequest.h.

◆ WithEngineVersion() [3/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithEngineVersion ( const char *  value)
inline

The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, the valid value is 2017.

Definition at line 553 of file CreateServerRequest.h.

◆ WithInstanceProfileArn() [1/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithInstanceProfileArn ( Aws::String &&  value)
inline

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.

Definition at line 926 of file CreateServerRequest.h.

◆ WithInstanceProfileArn() [2/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithInstanceProfileArn ( const Aws::String value)
inline

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.

Definition at line 915 of file CreateServerRequest.h.

◆ WithInstanceProfileArn() [3/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithInstanceProfileArn ( const char *  value)
inline

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.

Definition at line 937 of file CreateServerRequest.h.

◆ WithInstanceType() [1/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithInstanceType ( Aws::String &&  value)
inline

The Amazon EC2 instance type to use. For example, m5.large.

Definition at line 980 of file CreateServerRequest.h.

◆ WithInstanceType() [2/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithInstanceType ( const Aws::String value)
inline

The Amazon EC2 instance type to use. For example, m5.large.

Definition at line 974 of file CreateServerRequest.h.

◆ WithInstanceType() [3/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithInstanceType ( const char *  value)
inline

The Amazon EC2 instance type to use. For example, m5.large.

Definition at line 986 of file CreateServerRequest.h.

◆ WithKeyPair() [1/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithKeyPair ( Aws::String &&  value)
inline

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.

Definition at line 1036 of file CreateServerRequest.h.

◆ WithKeyPair() [2/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithKeyPair ( const Aws::String value)
inline

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.

Definition at line 1029 of file CreateServerRequest.h.

◆ WithKeyPair() [3/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithKeyPair ( const char *  value)
inline

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.

Definition at line 1043 of file CreateServerRequest.h.

◆ WithPreferredBackupWindow() [1/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithPreferredBackupWindow ( Aws::String &&  value)
inline

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

MM must be specified as 00. 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.)

Definition at line 1239 of file CreateServerRequest.h.

◆ WithPreferredBackupWindow() [2/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithPreferredBackupWindow ( const Aws::String value)
inline

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

MM must be specified as 00. 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.)

Definition at line 1225 of file CreateServerRequest.h.

◆ WithPreferredBackupWindow() [3/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithPreferredBackupWindow ( const char *  value)
inline

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

MM must be specified as 00. 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.)

Definition at line 1253 of file CreateServerRequest.h.

◆ WithPreferredMaintenanceWindow() [1/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithPreferredMaintenanceWindow ( Aws::String &&  value)
inline

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. MM must be specified as 00. 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.)

Definition at line 1128 of file CreateServerRequest.h.

◆ WithPreferredMaintenanceWindow() [2/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithPreferredMaintenanceWindow ( const Aws::String value)
inline

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. MM must be specified as 00. 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.)

Definition at line 1116 of file CreateServerRequest.h.

◆ WithPreferredMaintenanceWindow() [3/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithPreferredMaintenanceWindow ( const char *  value)
inline

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. MM must be specified as 00. 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.)

Definition at line 1140 of file CreateServerRequest.h.

◆ WithSecurityGroupIds() [1/2]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

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).

Definition at line 1308 of file CreateServerRequest.h.

◆ WithSecurityGroupIds() [2/2]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

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).

Definition at line 1299 of file CreateServerRequest.h.

◆ WithServerName() [1/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithServerName ( Aws::String &&  value)
inline

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.

Definition at line 840 of file CreateServerRequest.h.

◆ WithServerName() [2/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithServerName ( const Aws::String value)
inline

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.

Definition at line 832 of file CreateServerRequest.h.

◆ WithServerName() [3/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithServerName ( const char *  value)
inline

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.

Definition at line 848 of file CreateServerRequest.h.

◆ WithServiceRoleArn() [1/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithServiceRoleArn ( Aws::String &&  value)
inline

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.

Definition at line 1413 of file CreateServerRequest.h.

◆ WithServiceRoleArn() [2/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithServiceRoleArn ( const Aws::String value)
inline

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.

Definition at line 1402 of file CreateServerRequest.h.

◆ WithServiceRoleArn() [3/3]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithServiceRoleArn ( const char *  value)
inline

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.

Definition at line 1424 of file CreateServerRequest.h.

◆ WithSubnetIds() [1/2]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithSubnetIds ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 1509 of file CreateServerRequest.h.

◆ WithSubnetIds() [2/2]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithSubnetIds ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 1495 of file CreateServerRequest.h.

◆ WithTags() [1/2]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

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: + - = . _ : / </code>

  • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / </code>

  • 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.

Definition at line 1636 of file CreateServerRequest.h.

◆ WithTags() [2/2]

CreateServerRequest& Aws::OpsWorksCM::Model::CreateServerRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

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: + - = . _ : / </code>

  • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / </code>

  • 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.

Definition at line 1622 of file CreateServerRequest.h.


The documentation for this class was generated from the following file: