AWS SDK for C++  1.8.94
AWS SDK for C++
Public Member Functions | List of all members
Aws::OpsWorks::Model::CreateInstanceRequest Class Reference

#include <CreateInstanceRequest.h>

+ Inheritance diagram for Aws::OpsWorks::Model::CreateInstanceRequest:

Public Member Functions

 CreateInstanceRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetStackId () const
 
bool StackIdHasBeenSet () const
 
void SetStackId (const Aws::String &value)
 
void SetStackId (Aws::String &&value)
 
void SetStackId (const char *value)
 
CreateInstanceRequestWithStackId (const Aws::String &value)
 
CreateInstanceRequestWithStackId (Aws::String &&value)
 
CreateInstanceRequestWithStackId (const char *value)
 
const Aws::Vector< Aws::String > & GetLayerIds () const
 
bool LayerIdsHasBeenSet () const
 
void SetLayerIds (const Aws::Vector< Aws::String > &value)
 
void SetLayerIds (Aws::Vector< Aws::String > &&value)
 
CreateInstanceRequestWithLayerIds (const Aws::Vector< Aws::String > &value)
 
CreateInstanceRequestWithLayerIds (Aws::Vector< Aws::String > &&value)
 
CreateInstanceRequestAddLayerIds (const Aws::String &value)
 
CreateInstanceRequestAddLayerIds (Aws::String &&value)
 
CreateInstanceRequestAddLayerIds (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)
 
CreateInstanceRequestWithInstanceType (const Aws::String &value)
 
CreateInstanceRequestWithInstanceType (Aws::String &&value)
 
CreateInstanceRequestWithInstanceType (const char *value)
 
const AutoScalingTypeGetAutoScalingType () const
 
bool AutoScalingTypeHasBeenSet () const
 
void SetAutoScalingType (const AutoScalingType &value)
 
void SetAutoScalingType (AutoScalingType &&value)
 
CreateInstanceRequestWithAutoScalingType (const AutoScalingType &value)
 
CreateInstanceRequestWithAutoScalingType (AutoScalingType &&value)
 
const Aws::StringGetHostname () const
 
bool HostnameHasBeenSet () const
 
void SetHostname (const Aws::String &value)
 
void SetHostname (Aws::String &&value)
 
void SetHostname (const char *value)
 
CreateInstanceRequestWithHostname (const Aws::String &value)
 
CreateInstanceRequestWithHostname (Aws::String &&value)
 
CreateInstanceRequestWithHostname (const char *value)
 
const Aws::StringGetOs () const
 
bool OsHasBeenSet () const
 
void SetOs (const Aws::String &value)
 
void SetOs (Aws::String &&value)
 
void SetOs (const char *value)
 
CreateInstanceRequestWithOs (const Aws::String &value)
 
CreateInstanceRequestWithOs (Aws::String &&value)
 
CreateInstanceRequestWithOs (const char *value)
 
const Aws::StringGetAmiId () const
 
bool AmiIdHasBeenSet () const
 
void SetAmiId (const Aws::String &value)
 
void SetAmiId (Aws::String &&value)
 
void SetAmiId (const char *value)
 
CreateInstanceRequestWithAmiId (const Aws::String &value)
 
CreateInstanceRequestWithAmiId (Aws::String &&value)
 
CreateInstanceRequestWithAmiId (const char *value)
 
const Aws::StringGetSshKeyName () const
 
bool SshKeyNameHasBeenSet () const
 
void SetSshKeyName (const Aws::String &value)
 
void SetSshKeyName (Aws::String &&value)
 
void SetSshKeyName (const char *value)
 
CreateInstanceRequestWithSshKeyName (const Aws::String &value)
 
CreateInstanceRequestWithSshKeyName (Aws::String &&value)
 
CreateInstanceRequestWithSshKeyName (const char *value)
 
const Aws::StringGetAvailabilityZone () const
 
bool AvailabilityZoneHasBeenSet () const
 
void SetAvailabilityZone (const Aws::String &value)
 
void SetAvailabilityZone (Aws::String &&value)
 
void SetAvailabilityZone (const char *value)
 
CreateInstanceRequestWithAvailabilityZone (const Aws::String &value)
 
CreateInstanceRequestWithAvailabilityZone (Aws::String &&value)
 
CreateInstanceRequestWithAvailabilityZone (const char *value)
 
const Aws::StringGetVirtualizationType () const
 
bool VirtualizationTypeHasBeenSet () const
 
void SetVirtualizationType (const Aws::String &value)
 
void SetVirtualizationType (Aws::String &&value)
 
void SetVirtualizationType (const char *value)
 
CreateInstanceRequestWithVirtualizationType (const Aws::String &value)
 
CreateInstanceRequestWithVirtualizationType (Aws::String &&value)
 
CreateInstanceRequestWithVirtualizationType (const char *value)
 
const Aws::StringGetSubnetId () const
 
bool SubnetIdHasBeenSet () const
 
void SetSubnetId (const Aws::String &value)
 
void SetSubnetId (Aws::String &&value)
 
void SetSubnetId (const char *value)
 
CreateInstanceRequestWithSubnetId (const Aws::String &value)
 
CreateInstanceRequestWithSubnetId (Aws::String &&value)
 
CreateInstanceRequestWithSubnetId (const char *value)
 
const ArchitectureGetArchitecture () const
 
bool ArchitectureHasBeenSet () const
 
void SetArchitecture (const Architecture &value)
 
void SetArchitecture (Architecture &&value)
 
CreateInstanceRequestWithArchitecture (const Architecture &value)
 
CreateInstanceRequestWithArchitecture (Architecture &&value)
 
const RootDeviceTypeGetRootDeviceType () const
 
bool RootDeviceTypeHasBeenSet () const
 
void SetRootDeviceType (const RootDeviceType &value)
 
void SetRootDeviceType (RootDeviceType &&value)
 
CreateInstanceRequestWithRootDeviceType (const RootDeviceType &value)
 
CreateInstanceRequestWithRootDeviceType (RootDeviceType &&value)
 
const Aws::Vector< BlockDeviceMapping > & GetBlockDeviceMappings () const
 
bool BlockDeviceMappingsHasBeenSet () const
 
void SetBlockDeviceMappings (const Aws::Vector< BlockDeviceMapping > &value)
 
void SetBlockDeviceMappings (Aws::Vector< BlockDeviceMapping > &&value)
 
CreateInstanceRequestWithBlockDeviceMappings (const Aws::Vector< BlockDeviceMapping > &value)
 
CreateInstanceRequestWithBlockDeviceMappings (Aws::Vector< BlockDeviceMapping > &&value)
 
CreateInstanceRequestAddBlockDeviceMappings (const BlockDeviceMapping &value)
 
CreateInstanceRequestAddBlockDeviceMappings (BlockDeviceMapping &&value)
 
bool GetInstallUpdatesOnBoot () const
 
bool InstallUpdatesOnBootHasBeenSet () const
 
void SetInstallUpdatesOnBoot (bool value)
 
CreateInstanceRequestWithInstallUpdatesOnBoot (bool value)
 
bool GetEbsOptimized () const
 
bool EbsOptimizedHasBeenSet () const
 
void SetEbsOptimized (bool value)
 
CreateInstanceRequestWithEbsOptimized (bool value)
 
const Aws::StringGetAgentVersion () const
 
bool AgentVersionHasBeenSet () const
 
void SetAgentVersion (const Aws::String &value)
 
void SetAgentVersion (Aws::String &&value)
 
void SetAgentVersion (const char *value)
 
CreateInstanceRequestWithAgentVersion (const Aws::String &value)
 
CreateInstanceRequestWithAgentVersion (Aws::String &&value)
 
CreateInstanceRequestWithAgentVersion (const char *value)
 
const Aws::StringGetTenancy () const
 
bool TenancyHasBeenSet () const
 
void SetTenancy (const Aws::String &value)
 
void SetTenancy (Aws::String &&value)
 
void SetTenancy (const char *value)
 
CreateInstanceRequestWithTenancy (const Aws::String &value)
 
CreateInstanceRequestWithTenancy (Aws::String &&value)
 
CreateInstanceRequestWithTenancy (const char *value)
 
- Public Member Functions inherited from Aws::OpsWorks::OpsWorksRequest
virtual ~OpsWorksRequest ()
 
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 26 of file CreateInstanceRequest.h.

Constructor & Destructor Documentation

◆ CreateInstanceRequest()

Aws::OpsWorks::Model::CreateInstanceRequest::CreateInstanceRequest ( )

Member Function Documentation

◆ AddBlockDeviceMappings() [1/2]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::AddBlockDeviceMappings ( const BlockDeviceMapping value)
inline

An array of BlockDeviceMapping objects that specify the instance's block devices. For more information, see Block Device Mapping. Note that block device mappings are not supported for custom AMIs.

Definition at line 997 of file CreateInstanceRequest.h.

◆ AddBlockDeviceMappings() [2/2]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::AddBlockDeviceMappings ( BlockDeviceMapping &&  value)
inline

An array of BlockDeviceMapping objects that specify the instance's block devices. For more information, see Block Device Mapping. Note that block device mappings are not supported for custom AMIs.

Definition at line 1006 of file CreateInstanceRequest.h.

◆ AddLayerIds() [1/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::AddLayerIds ( const Aws::String value)
inline

An array that contains the instance's layer IDs.

Definition at line 116 of file CreateInstanceRequest.h.

◆ AddLayerIds() [2/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::AddLayerIds ( Aws::String &&  value)
inline

An array that contains the instance's layer IDs.

Definition at line 121 of file CreateInstanceRequest.h.

◆ AddLayerIds() [3/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::AddLayerIds ( const char *  value)
inline

An array that contains the instance's layer IDs.

Definition at line 126 of file CreateInstanceRequest.h.

◆ AgentVersionHasBeenSet()

bool Aws::OpsWorks::Model::CreateInstanceRequest::AgentVersionHasBeenSet ( ) const
inline

The default AWS OpsWorks Stacks agent version. You have the following options:

  • INHERIT - Use the stack's default agent version setting.

  • version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.

The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

Definition at line 1109 of file CreateInstanceRequest.h.

◆ AmiIdHasBeenSet()

bool Aws::OpsWorks::Model::CreateInstanceRequest::AmiIdHasBeenSet ( ) const
inline

A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.

If you specify a custom AMI, you must set Os to Custom.

Definition at line 577 of file CreateInstanceRequest.h.

◆ ArchitectureHasBeenSet()

bool Aws::OpsWorks::Model::CreateInstanceRequest::ArchitectureHasBeenSet ( ) const
inline

The instance architecture. The default option is x86_64. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

Definition at line 854 of file CreateInstanceRequest.h.

◆ AutoScalingTypeHasBeenSet()

bool Aws::OpsWorks::Model::CreateInstanceRequest::AutoScalingTypeHasBeenSet ( ) const
inline

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

Definition at line 236 of file CreateInstanceRequest.h.

◆ AvailabilityZoneHasBeenSet()

bool Aws::OpsWorks::Model::CreateInstanceRequest::AvailabilityZoneHasBeenSet ( ) const
inline

The instance Availability Zone. For more information, see Regions and Endpoints.

Definition at line 687 of file CreateInstanceRequest.h.

◆ BlockDeviceMappingsHasBeenSet()

bool Aws::OpsWorks::Model::CreateInstanceRequest::BlockDeviceMappingsHasBeenSet ( ) const
inline

An array of BlockDeviceMapping objects that specify the instance's block devices. For more information, see Block Device Mapping. Note that block device mappings are not supported for custom AMIs.

Definition at line 952 of file CreateInstanceRequest.h.

◆ EbsOptimizedHasBeenSet()

bool Aws::OpsWorks::Model::CreateInstanceRequest::EbsOptimizedHasBeenSet ( ) const
inline

Whether to create an Amazon EBS-optimized instance.

Definition at line 1070 of file CreateInstanceRequest.h.

◆ GetAgentVersion()

const Aws::String& Aws::OpsWorks::Model::CreateInstanceRequest::GetAgentVersion ( ) const
inline

The default AWS OpsWorks Stacks agent version. You have the following options:

  • INHERIT - Use the stack's default agent version setting.

  • version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.

The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

Definition at line 1095 of file CreateInstanceRequest.h.

◆ GetAmiId()

const Aws::String& Aws::OpsWorks::Model::CreateInstanceRequest::GetAmiId ( ) const
inline

A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.

If you specify a custom AMI, you must set Os to Custom.

Definition at line 568 of file CreateInstanceRequest.h.

◆ GetArchitecture()

const Architecture& Aws::OpsWorks::Model::CreateInstanceRequest::GetArchitecture ( ) const
inline

The instance architecture. The default option is x86_64. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

Definition at line 845 of file CreateInstanceRequest.h.

◆ GetAutoScalingType()

const AutoScalingType& Aws::OpsWorks::Model::CreateInstanceRequest::GetAutoScalingType ( ) const
inline

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

Definition at line 230 of file CreateInstanceRequest.h.

◆ GetAvailabilityZone()

const Aws::String& Aws::OpsWorks::Model::CreateInstanceRequest::GetAvailabilityZone ( ) const
inline

The instance Availability Zone. For more information, see Regions and Endpoints.

Definition at line 680 of file CreateInstanceRequest.h.

◆ GetBlockDeviceMappings()

const Aws::Vector<BlockDeviceMapping>& Aws::OpsWorks::Model::CreateInstanceRequest::GetBlockDeviceMappings ( ) const
inline

An array of BlockDeviceMapping objects that specify the instance's block devices. For more information, see Block Device Mapping. Note that block device mappings are not supported for custom AMIs.

Definition at line 943 of file CreateInstanceRequest.h.

◆ GetEbsOptimized()

bool Aws::OpsWorks::Model::CreateInstanceRequest::GetEbsOptimized ( ) const
inline

Whether to create an Amazon EBS-optimized instance.

Definition at line 1065 of file CreateInstanceRequest.h.

◆ GetHostname()

const Aws::String& Aws::OpsWorks::Model::CreateInstanceRequest::GetHostname ( ) const
inline

The instance host name.

Definition at line 266 of file CreateInstanceRequest.h.

◆ GetInstallUpdatesOnBoot()

bool Aws::OpsWorks::Model::CreateInstanceRequest::GetInstallUpdatesOnBoot ( ) const
inline

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true to ensure that your instances have the latest security updates.

Definition at line 1020 of file CreateInstanceRequest.h.

◆ GetInstanceType()

const Aws::String& Aws::OpsWorks::Model::CreateInstanceRequest::GetInstanceType ( ) const
inline

The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

Definition at line 139 of file CreateInstanceRequest.h.

◆ GetLayerIds()

const Aws::Vector<Aws::String>& Aws::OpsWorks::Model::CreateInstanceRequest::GetLayerIds ( ) const
inline

An array that contains the instance's layer IDs.

Definition at line 86 of file CreateInstanceRequest.h.

◆ GetOs()

const Aws::String& Aws::OpsWorks::Model::CreateInstanceRequest::GetOs ( ) const
inline

The instance's operating system, which must be set to one of the following.

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

  • CentOS Linux 7

  • Red Hat Enterprise Linux 7

  • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

  • A custom AMI: Custom.

For more information about the supported operating systems, see AWS OpsWorks Stacks Operating Systems.

The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. For more information about supported operating systems, see Operating SystemsFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs.

Definition at line 334 of file CreateInstanceRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::OpsWorks::Model::CreateInstanceRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::OpsWorks::OpsWorksRequest.

◆ GetRootDeviceType()

const RootDeviceType& Aws::OpsWorks::Model::CreateInstanceRequest::GetRootDeviceType ( ) const
inline

The instance root device type. For more information, see Storage for the Root Device.

Definition at line 898 of file CreateInstanceRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::OpsWorks::Model::CreateInstanceRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file CreateInstanceRequest.h.

◆ GetSshKeyName()

const Aws::String& Aws::OpsWorks::Model::CreateInstanceRequest::GetSshKeyName ( ) const
inline

The instance's Amazon EC2 key-pair name.

Definition at line 637 of file CreateInstanceRequest.h.

◆ GetStackId()

const Aws::String& Aws::OpsWorks::Model::CreateInstanceRequest::GetStackId ( ) const
inline

The stack ID.

Definition at line 45 of file CreateInstanceRequest.h.

◆ GetSubnetId()

const Aws::String& Aws::OpsWorks::Model::CreateInstanceRequest::GetSubnetId ( ) const
inline

The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.

Definition at line 786 of file CreateInstanceRequest.h.

◆ GetTenancy()

const Aws::String& Aws::OpsWorks::Model::CreateInstanceRequest::GetTenancy ( ) const
inline

The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.

Definition at line 1211 of file CreateInstanceRequest.h.

◆ GetVirtualizationType()

const Aws::String& Aws::OpsWorks::Model::CreateInstanceRequest::GetVirtualizationType ( ) const
inline

The instance's virtualization type, paravirtual or hvm.

Definition at line 736 of file CreateInstanceRequest.h.

◆ HostnameHasBeenSet()

bool Aws::OpsWorks::Model::CreateInstanceRequest::HostnameHasBeenSet ( ) const
inline

The instance host name.

Definition at line 271 of file CreateInstanceRequest.h.

◆ InstallUpdatesOnBootHasBeenSet()

bool Aws::OpsWorks::Model::CreateInstanceRequest::InstallUpdatesOnBootHasBeenSet ( ) const
inline

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true to ensure that your instances have the latest security updates.

Definition at line 1033 of file CreateInstanceRequest.h.

◆ InstanceTypeHasBeenSet()

bool Aws::OpsWorks::Model::CreateInstanceRequest::InstanceTypeHasBeenSet ( ) const
inline

The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

Definition at line 151 of file CreateInstanceRequest.h.

◆ LayerIdsHasBeenSet()

bool Aws::OpsWorks::Model::CreateInstanceRequest::LayerIdsHasBeenSet ( ) const
inline

An array that contains the instance's layer IDs.

Definition at line 91 of file CreateInstanceRequest.h.

◆ OsHasBeenSet()

bool Aws::OpsWorks::Model::CreateInstanceRequest::OsHasBeenSet ( ) const
inline

The instance's operating system, which must be set to one of the following.

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

  • CentOS Linux 7

  • Red Hat Enterprise Linux 7

  • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

  • A custom AMI: Custom.

For more information about the supported operating systems, see AWS OpsWorks Stacks Operating Systems.

The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. For more information about supported operating systems, see Operating SystemsFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs.

Definition at line 366 of file CreateInstanceRequest.h.

◆ RootDeviceTypeHasBeenSet()

bool Aws::OpsWorks::Model::CreateInstanceRequest::RootDeviceTypeHasBeenSet ( ) const
inline

The instance root device type. For more information, see Storage for the Root Device.

Definition at line 905 of file CreateInstanceRequest.h.

◆ SerializePayload()

Aws::String Aws::OpsWorks::Model::CreateInstanceRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAgentVersion() [1/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetAgentVersion ( const Aws::String value)
inline

The default AWS OpsWorks Stacks agent version. You have the following options:

  • INHERIT - Use the stack's default agent version setting.

  • version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.

The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

Definition at line 1123 of file CreateInstanceRequest.h.

◆ SetAgentVersion() [2/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetAgentVersion ( Aws::String &&  value)
inline

The default AWS OpsWorks Stacks agent version. You have the following options:

  • INHERIT - Use the stack's default agent version setting.

  • version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.

The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

Definition at line 1137 of file CreateInstanceRequest.h.

◆ SetAgentVersion() [3/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetAgentVersion ( const char *  value)
inline

The default AWS OpsWorks Stacks agent version. You have the following options:

  • INHERIT - Use the stack's default agent version setting.

  • version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.

The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

Definition at line 1151 of file CreateInstanceRequest.h.

◆ SetAmiId() [1/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetAmiId ( const Aws::String value)
inline

A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.

If you specify a custom AMI, you must set Os to Custom.

Definition at line 586 of file CreateInstanceRequest.h.

◆ SetAmiId() [2/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetAmiId ( Aws::String &&  value)
inline

A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.

If you specify a custom AMI, you must set Os to Custom.

Definition at line 595 of file CreateInstanceRequest.h.

◆ SetAmiId() [3/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetAmiId ( const char *  value)
inline

A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.

If you specify a custom AMI, you must set Os to Custom.

Definition at line 604 of file CreateInstanceRequest.h.

◆ SetArchitecture() [1/2]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetArchitecture ( const Architecture value)
inline

The instance architecture. The default option is x86_64. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

Definition at line 863 of file CreateInstanceRequest.h.

◆ SetArchitecture() [2/2]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetArchitecture ( Architecture &&  value)
inline

The instance architecture. The default option is x86_64. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

Definition at line 872 of file CreateInstanceRequest.h.

◆ SetAutoScalingType() [1/2]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetAutoScalingType ( const AutoScalingType value)
inline

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

Definition at line 242 of file CreateInstanceRequest.h.

◆ SetAutoScalingType() [2/2]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetAutoScalingType ( AutoScalingType &&  value)
inline

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

Definition at line 248 of file CreateInstanceRequest.h.

◆ SetAvailabilityZone() [1/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetAvailabilityZone ( const Aws::String value)
inline

The instance Availability Zone. For more information, see Regions and Endpoints.

Definition at line 694 of file CreateInstanceRequest.h.

◆ SetAvailabilityZone() [2/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetAvailabilityZone ( Aws::String &&  value)
inline

The instance Availability Zone. For more information, see Regions and Endpoints.

Definition at line 701 of file CreateInstanceRequest.h.

◆ SetAvailabilityZone() [3/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetAvailabilityZone ( const char *  value)
inline

The instance Availability Zone. For more information, see Regions and Endpoints.

Definition at line 708 of file CreateInstanceRequest.h.

◆ SetBlockDeviceMappings() [1/2]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetBlockDeviceMappings ( const Aws::Vector< BlockDeviceMapping > &  value)
inline

An array of BlockDeviceMapping objects that specify the instance's block devices. For more information, see Block Device Mapping. Note that block device mappings are not supported for custom AMIs.

Definition at line 961 of file CreateInstanceRequest.h.

◆ SetBlockDeviceMappings() [2/2]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetBlockDeviceMappings ( Aws::Vector< BlockDeviceMapping > &&  value)
inline

An array of BlockDeviceMapping objects that specify the instance's block devices. For more information, see Block Device Mapping. Note that block device mappings are not supported for custom AMIs.

Definition at line 970 of file CreateInstanceRequest.h.

◆ SetEbsOptimized()

void Aws::OpsWorks::Model::CreateInstanceRequest::SetEbsOptimized ( bool  value)
inline

Whether to create an Amazon EBS-optimized instance.

Definition at line 1075 of file CreateInstanceRequest.h.

◆ SetHostname() [1/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetHostname ( const Aws::String value)
inline

The instance host name.

Definition at line 276 of file CreateInstanceRequest.h.

◆ SetHostname() [2/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetHostname ( Aws::String &&  value)
inline

The instance host name.

Definition at line 281 of file CreateInstanceRequest.h.

◆ SetHostname() [3/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetHostname ( const char *  value)
inline

The instance host name.

Definition at line 286 of file CreateInstanceRequest.h.

◆ SetInstallUpdatesOnBoot()

void Aws::OpsWorks::Model::CreateInstanceRequest::SetInstallUpdatesOnBoot ( bool  value)
inline

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true to ensure that your instances have the latest security updates.

Definition at line 1046 of file CreateInstanceRequest.h.

◆ SetInstanceType() [1/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetInstanceType ( const Aws::String value)
inline

The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

Definition at line 163 of file CreateInstanceRequest.h.

◆ SetInstanceType() [2/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetInstanceType ( Aws::String &&  value)
inline

The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

Definition at line 175 of file CreateInstanceRequest.h.

◆ SetInstanceType() [3/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetInstanceType ( const char *  value)
inline

The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

Definition at line 187 of file CreateInstanceRequest.h.

◆ SetLayerIds() [1/2]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetLayerIds ( const Aws::Vector< Aws::String > &  value)
inline

An array that contains the instance's layer IDs.

Definition at line 96 of file CreateInstanceRequest.h.

◆ SetLayerIds() [2/2]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetLayerIds ( Aws::Vector< Aws::String > &&  value)
inline

An array that contains the instance's layer IDs.

Definition at line 101 of file CreateInstanceRequest.h.

◆ SetOs() [1/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetOs ( const Aws::String value)
inline

The instance's operating system, which must be set to one of the following.

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

  • CentOS Linux 7

  • Red Hat Enterprise Linux 7

  • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

  • A custom AMI: Custom.

For more information about the supported operating systems, see AWS OpsWorks Stacks Operating Systems.

The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. For more information about supported operating systems, see Operating SystemsFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs.

Definition at line 398 of file CreateInstanceRequest.h.

◆ SetOs() [2/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetOs ( Aws::String &&  value)
inline

The instance's operating system, which must be set to one of the following.

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

  • CentOS Linux 7

  • Red Hat Enterprise Linux 7

  • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

  • A custom AMI: Custom.

For more information about the supported operating systems, see AWS OpsWorks Stacks Operating Systems.

The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. For more information about supported operating systems, see Operating SystemsFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs.

Definition at line 430 of file CreateInstanceRequest.h.

◆ SetOs() [3/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetOs ( const char *  value)
inline

The instance's operating system, which must be set to one of the following.

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

  • CentOS Linux 7

  • Red Hat Enterprise Linux 7

  • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

  • A custom AMI: Custom.

For more information about the supported operating systems, see AWS OpsWorks Stacks Operating Systems.

The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. For more information about supported operating systems, see Operating SystemsFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs.

Definition at line 462 of file CreateInstanceRequest.h.

◆ SetRootDeviceType() [1/2]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetRootDeviceType ( const RootDeviceType value)
inline

The instance root device type. For more information, see Storage for the Root Device.

Definition at line 912 of file CreateInstanceRequest.h.

◆ SetRootDeviceType() [2/2]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetRootDeviceType ( RootDeviceType &&  value)
inline

The instance root device type. For more information, see Storage for the Root Device.

Definition at line 919 of file CreateInstanceRequest.h.

◆ SetSshKeyName() [1/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetSshKeyName ( const Aws::String value)
inline

The instance's Amazon EC2 key-pair name.

Definition at line 647 of file CreateInstanceRequest.h.

◆ SetSshKeyName() [2/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetSshKeyName ( Aws::String &&  value)
inline

The instance's Amazon EC2 key-pair name.

Definition at line 652 of file CreateInstanceRequest.h.

◆ SetSshKeyName() [3/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetSshKeyName ( const char *  value)
inline

The instance's Amazon EC2 key-pair name.

Definition at line 657 of file CreateInstanceRequest.h.

◆ SetStackId() [1/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetStackId ( const Aws::String value)
inline

The stack ID.

Definition at line 55 of file CreateInstanceRequest.h.

◆ SetStackId() [2/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetStackId ( Aws::String &&  value)
inline

The stack ID.

Definition at line 60 of file CreateInstanceRequest.h.

◆ SetStackId() [3/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetStackId ( const char *  value)
inline

The stack ID.

Definition at line 65 of file CreateInstanceRequest.h.

◆ SetSubnetId() [1/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetSubnetId ( const Aws::String value)
inline

The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.

Definition at line 800 of file CreateInstanceRequest.h.

◆ SetSubnetId() [2/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetSubnetId ( Aws::String &&  value)
inline

The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.

Definition at line 807 of file CreateInstanceRequest.h.

◆ SetSubnetId() [3/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetSubnetId ( const char *  value)
inline

The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.

Definition at line 814 of file CreateInstanceRequest.h.

◆ SetTenancy() [1/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetTenancy ( const Aws::String value)
inline

The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.

Definition at line 1245 of file CreateInstanceRequest.h.

◆ SetTenancy() [2/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetTenancy ( Aws::String &&  value)
inline

The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.

Definition at line 1262 of file CreateInstanceRequest.h.

◆ SetTenancy() [3/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetTenancy ( const char *  value)
inline

The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.

Definition at line 1279 of file CreateInstanceRequest.h.

◆ SetVirtualizationType() [1/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetVirtualizationType ( const Aws::String value)
inline

The instance's virtualization type, paravirtual or hvm.

Definition at line 748 of file CreateInstanceRequest.h.

◆ SetVirtualizationType() [2/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetVirtualizationType ( Aws::String &&  value)
inline

The instance's virtualization type, paravirtual or hvm.

Definition at line 754 of file CreateInstanceRequest.h.

◆ SetVirtualizationType() [3/3]

void Aws::OpsWorks::Model::CreateInstanceRequest::SetVirtualizationType ( const char *  value)
inline

The instance's virtualization type, paravirtual or hvm.

Definition at line 760 of file CreateInstanceRequest.h.

◆ SshKeyNameHasBeenSet()

bool Aws::OpsWorks::Model::CreateInstanceRequest::SshKeyNameHasBeenSet ( ) const
inline

The instance's Amazon EC2 key-pair name.

Definition at line 642 of file CreateInstanceRequest.h.

◆ StackIdHasBeenSet()

bool Aws::OpsWorks::Model::CreateInstanceRequest::StackIdHasBeenSet ( ) const
inline

The stack ID.

Definition at line 50 of file CreateInstanceRequest.h.

◆ SubnetIdHasBeenSet()

bool Aws::OpsWorks::Model::CreateInstanceRequest::SubnetIdHasBeenSet ( ) const
inline

The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.

Definition at line 793 of file CreateInstanceRequest.h.

◆ TenancyHasBeenSet()

bool Aws::OpsWorks::Model::CreateInstanceRequest::TenancyHasBeenSet ( ) const
inline

The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.

Definition at line 1228 of file CreateInstanceRequest.h.

◆ VirtualizationTypeHasBeenSet()

bool Aws::OpsWorks::Model::CreateInstanceRequest::VirtualizationTypeHasBeenSet ( ) const
inline

The instance's virtualization type, paravirtual or hvm.

Definition at line 742 of file CreateInstanceRequest.h.

◆ WithAgentVersion() [1/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithAgentVersion ( const Aws::String value)
inline

The default AWS OpsWorks Stacks agent version. You have the following options:

  • INHERIT - Use the stack's default agent version setting.

  • version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.

The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

Definition at line 1165 of file CreateInstanceRequest.h.

◆ WithAgentVersion() [2/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithAgentVersion ( Aws::String &&  value)
inline

The default AWS OpsWorks Stacks agent version. You have the following options:

  • INHERIT - Use the stack's default agent version setting.

  • version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.

The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

Definition at line 1179 of file CreateInstanceRequest.h.

◆ WithAgentVersion() [3/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithAgentVersion ( const char *  value)
inline

The default AWS OpsWorks Stacks agent version. You have the following options:

  • INHERIT - Use the stack's default agent version setting.

  • version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.

The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

Definition at line 1193 of file CreateInstanceRequest.h.

◆ WithAmiId() [1/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithAmiId ( const Aws::String value)
inline

A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.

If you specify a custom AMI, you must set Os to Custom.

Definition at line 613 of file CreateInstanceRequest.h.

◆ WithAmiId() [2/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithAmiId ( Aws::String &&  value)
inline

A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.

If you specify a custom AMI, you must set Os to Custom.

Definition at line 622 of file CreateInstanceRequest.h.

◆ WithAmiId() [3/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithAmiId ( const char *  value)
inline

A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.

If you specify a custom AMI, you must set Os to Custom.

Definition at line 631 of file CreateInstanceRequest.h.

◆ WithArchitecture() [1/2]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithArchitecture ( const Architecture value)
inline

The instance architecture. The default option is x86_64. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

Definition at line 881 of file CreateInstanceRequest.h.

◆ WithArchitecture() [2/2]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithArchitecture ( Architecture &&  value)
inline

The instance architecture. The default option is x86_64. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

Definition at line 890 of file CreateInstanceRequest.h.

◆ WithAutoScalingType() [1/2]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithAutoScalingType ( const AutoScalingType value)
inline

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

Definition at line 254 of file CreateInstanceRequest.h.

◆ WithAutoScalingType() [2/2]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithAutoScalingType ( AutoScalingType &&  value)
inline

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

Definition at line 260 of file CreateInstanceRequest.h.

◆ WithAvailabilityZone() [1/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithAvailabilityZone ( const Aws::String value)
inline

The instance Availability Zone. For more information, see Regions and Endpoints.

Definition at line 715 of file CreateInstanceRequest.h.

◆ WithAvailabilityZone() [2/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithAvailabilityZone ( Aws::String &&  value)
inline

The instance Availability Zone. For more information, see Regions and Endpoints.

Definition at line 722 of file CreateInstanceRequest.h.

◆ WithAvailabilityZone() [3/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithAvailabilityZone ( const char *  value)
inline

The instance Availability Zone. For more information, see Regions and Endpoints.

Definition at line 729 of file CreateInstanceRequest.h.

◆ WithBlockDeviceMappings() [1/2]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithBlockDeviceMappings ( const Aws::Vector< BlockDeviceMapping > &  value)
inline

An array of BlockDeviceMapping objects that specify the instance's block devices. For more information, see Block Device Mapping. Note that block device mappings are not supported for custom AMIs.

Definition at line 979 of file CreateInstanceRequest.h.

◆ WithBlockDeviceMappings() [2/2]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithBlockDeviceMappings ( Aws::Vector< BlockDeviceMapping > &&  value)
inline

An array of BlockDeviceMapping objects that specify the instance's block devices. For more information, see Block Device Mapping. Note that block device mappings are not supported for custom AMIs.

Definition at line 988 of file CreateInstanceRequest.h.

◆ WithEbsOptimized()

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithEbsOptimized ( bool  value)
inline

Whether to create an Amazon EBS-optimized instance.

Definition at line 1080 of file CreateInstanceRequest.h.

◆ WithHostname() [1/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithHostname ( const Aws::String value)
inline

The instance host name.

Definition at line 291 of file CreateInstanceRequest.h.

◆ WithHostname() [2/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithHostname ( Aws::String &&  value)
inline

The instance host name.

Definition at line 296 of file CreateInstanceRequest.h.

◆ WithHostname() [3/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithHostname ( const char *  value)
inline

The instance host name.

Definition at line 301 of file CreateInstanceRequest.h.

◆ WithInstallUpdatesOnBoot()

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithInstallUpdatesOnBoot ( bool  value)
inline

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true to ensure that your instances have the latest security updates.

Definition at line 1059 of file CreateInstanceRequest.h.

◆ WithInstanceType() [1/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithInstanceType ( const Aws::String value)
inline

The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

Definition at line 199 of file CreateInstanceRequest.h.

◆ WithInstanceType() [2/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithInstanceType ( Aws::String &&  value)
inline

The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

Definition at line 211 of file CreateInstanceRequest.h.

◆ WithInstanceType() [3/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithInstanceType ( const char *  value)
inline

The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

Definition at line 223 of file CreateInstanceRequest.h.

◆ WithLayerIds() [1/2]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithLayerIds ( const Aws::Vector< Aws::String > &  value)
inline

An array that contains the instance's layer IDs.

Definition at line 106 of file CreateInstanceRequest.h.

◆ WithLayerIds() [2/2]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithLayerIds ( Aws::Vector< Aws::String > &&  value)
inline

An array that contains the instance's layer IDs.

Definition at line 111 of file CreateInstanceRequest.h.

◆ WithOs() [1/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithOs ( const Aws::String value)
inline

The instance's operating system, which must be set to one of the following.

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

  • CentOS Linux 7

  • Red Hat Enterprise Linux 7

  • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

  • A custom AMI: Custom.

For more information about the supported operating systems, see AWS OpsWorks Stacks Operating Systems.

The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. For more information about supported operating systems, see Operating SystemsFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs.

Definition at line 494 of file CreateInstanceRequest.h.

◆ WithOs() [2/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithOs ( Aws::String &&  value)
inline

The instance's operating system, which must be set to one of the following.

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

  • CentOS Linux 7

  • Red Hat Enterprise Linux 7

  • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

  • A custom AMI: Custom.

For more information about the supported operating systems, see AWS OpsWorks Stacks Operating Systems.

The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. For more information about supported operating systems, see Operating SystemsFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs.

Definition at line 526 of file CreateInstanceRequest.h.

◆ WithOs() [3/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithOs ( const char *  value)
inline

The instance's operating system, which must be set to one of the following.

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

  • CentOS Linux 7

  • Red Hat Enterprise Linux 7

  • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

  • A custom AMI: Custom.

For more information about the supported operating systems, see AWS OpsWorks Stacks Operating Systems.

The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. For more information about supported operating systems, see Operating SystemsFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs.

Definition at line 558 of file CreateInstanceRequest.h.

◆ WithRootDeviceType() [1/2]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithRootDeviceType ( const RootDeviceType value)
inline

The instance root device type. For more information, see Storage for the Root Device.

Definition at line 926 of file CreateInstanceRequest.h.

◆ WithRootDeviceType() [2/2]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithRootDeviceType ( RootDeviceType &&  value)
inline

The instance root device type. For more information, see Storage for the Root Device.

Definition at line 933 of file CreateInstanceRequest.h.

◆ WithSshKeyName() [1/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithSshKeyName ( const Aws::String value)
inline

The instance's Amazon EC2 key-pair name.

Definition at line 662 of file CreateInstanceRequest.h.

◆ WithSshKeyName() [2/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithSshKeyName ( Aws::String &&  value)
inline

The instance's Amazon EC2 key-pair name.

Definition at line 667 of file CreateInstanceRequest.h.

◆ WithSshKeyName() [3/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithSshKeyName ( const char *  value)
inline

The instance's Amazon EC2 key-pair name.

Definition at line 672 of file CreateInstanceRequest.h.

◆ WithStackId() [1/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithStackId ( const Aws::String value)
inline

The stack ID.

Definition at line 70 of file CreateInstanceRequest.h.

◆ WithStackId() [2/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithStackId ( Aws::String &&  value)
inline

The stack ID.

Definition at line 75 of file CreateInstanceRequest.h.

◆ WithStackId() [3/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithStackId ( const char *  value)
inline

The stack ID.

Definition at line 80 of file CreateInstanceRequest.h.

◆ WithSubnetId() [1/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithSubnetId ( const Aws::String value)
inline

The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.

Definition at line 821 of file CreateInstanceRequest.h.

◆ WithSubnetId() [2/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithSubnetId ( Aws::String &&  value)
inline

The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.

Definition at line 828 of file CreateInstanceRequest.h.

◆ WithSubnetId() [3/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithSubnetId ( const char *  value)
inline

The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.

Definition at line 835 of file CreateInstanceRequest.h.

◆ WithTenancy() [1/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithTenancy ( const Aws::String value)
inline

The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.

Definition at line 1296 of file CreateInstanceRequest.h.

◆ WithTenancy() [2/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithTenancy ( Aws::String &&  value)
inline

The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.

Definition at line 1313 of file CreateInstanceRequest.h.

◆ WithTenancy() [3/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithTenancy ( const char *  value)
inline

The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.

Definition at line 1330 of file CreateInstanceRequest.h.

◆ WithVirtualizationType() [1/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithVirtualizationType ( const Aws::String value)
inline

The instance's virtualization type, paravirtual or hvm.

Definition at line 766 of file CreateInstanceRequest.h.

◆ WithVirtualizationType() [2/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithVirtualizationType ( Aws::String &&  value)
inline

The instance's virtualization type, paravirtual or hvm.

Definition at line 772 of file CreateInstanceRequest.h.

◆ WithVirtualizationType() [3/3]

CreateInstanceRequest& Aws::OpsWorks::Model::CreateInstanceRequest::WithVirtualizationType ( const char *  value)
inline

The instance's virtualization type, paravirtual or hvm.

Definition at line 778 of file CreateInstanceRequest.h.


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