This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-autoscaling/include/aws/autoscaling/model/LaunchTemplateSpecification.h

337 lines
20 KiB
C
Raw Normal View History

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/autoscaling/AutoScaling_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSStreamFwd.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Xml
{
class XmlNode;
} // namespace Xml
} // namespace Utils
namespace AutoScaling
{
namespace Model
{
/**
* <p>Describes the Amazon EC2 launch template and the launch template version that
* can be used by an Auto Scaling group to configure Amazon EC2 instances.</p>
* <p>The launch template that is specified must be configured for use with an Auto
* Scaling group. For more information, see <a
* href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html">Creating
* a Launch Template for an Auto Scaling Group</a> in the <i>Amazon EC2 Auto
* Scaling User Guide</i>.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/LaunchTemplateSpecification">AWS
* API Reference</a></p>
*/
class AWS_AUTOSCALING_API LaunchTemplateSpecification
{
public:
LaunchTemplateSpecification();
LaunchTemplateSpecification(const Aws::Utils::Xml::XmlNode& xmlNode);
LaunchTemplateSpecification& operator=(const Aws::Utils::Xml::XmlNode& xmlNode);
void OutputToStream(Aws::OStream& ostream, const char* location, unsigned index, const char* locationValue) const;
void OutputToStream(Aws::OStream& oStream, const char* location) const;
/**
* <p>The ID of the launch template. To get the template ID, use the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html">DescribeLaunchTemplates</a>
* API operation. New launch templates can be created using the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a>
* API.</p> <p>You must specify either a template ID or a template name.</p>
*/
inline const Aws::String& GetLaunchTemplateId() const{ return m_launchTemplateId; }
/**
* <p>The ID of the launch template. To get the template ID, use the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html">DescribeLaunchTemplates</a>
* API operation. New launch templates can be created using the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a>
* API.</p> <p>You must specify either a template ID or a template name.</p>
*/
inline bool LaunchTemplateIdHasBeenSet() const { return m_launchTemplateIdHasBeenSet; }
/**
* <p>The ID of the launch template. To get the template ID, use the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html">DescribeLaunchTemplates</a>
* API operation. New launch templates can be created using the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a>
* API.</p> <p>You must specify either a template ID or a template name.</p>
*/
inline void SetLaunchTemplateId(const Aws::String& value) { m_launchTemplateIdHasBeenSet = true; m_launchTemplateId = value; }
/**
* <p>The ID of the launch template. To get the template ID, use the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html">DescribeLaunchTemplates</a>
* API operation. New launch templates can be created using the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a>
* API.</p> <p>You must specify either a template ID or a template name.</p>
*/
inline void SetLaunchTemplateId(Aws::String&& value) { m_launchTemplateIdHasBeenSet = true; m_launchTemplateId = std::move(value); }
/**
* <p>The ID of the launch template. To get the template ID, use the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html">DescribeLaunchTemplates</a>
* API operation. New launch templates can be created using the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a>
* API.</p> <p>You must specify either a template ID or a template name.</p>
*/
inline void SetLaunchTemplateId(const char* value) { m_launchTemplateIdHasBeenSet = true; m_launchTemplateId.assign(value); }
/**
* <p>The ID of the launch template. To get the template ID, use the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html">DescribeLaunchTemplates</a>
* API operation. New launch templates can be created using the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a>
* API.</p> <p>You must specify either a template ID or a template name.</p>
*/
inline LaunchTemplateSpecification& WithLaunchTemplateId(const Aws::String& value) { SetLaunchTemplateId(value); return *this;}
/**
* <p>The ID of the launch template. To get the template ID, use the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html">DescribeLaunchTemplates</a>
* API operation. New launch templates can be created using the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a>
* API.</p> <p>You must specify either a template ID or a template name.</p>
*/
inline LaunchTemplateSpecification& WithLaunchTemplateId(Aws::String&& value) { SetLaunchTemplateId(std::move(value)); return *this;}
/**
* <p>The ID of the launch template. To get the template ID, use the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html">DescribeLaunchTemplates</a>
* API operation. New launch templates can be created using the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a>
* API.</p> <p>You must specify either a template ID or a template name.</p>
*/
inline LaunchTemplateSpecification& WithLaunchTemplateId(const char* value) { SetLaunchTemplateId(value); return *this;}
/**
* <p>The name of the launch template. To get the template name, use the Amazon EC2
* <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html">DescribeLaunchTemplates</a>
* API operation. New launch templates can be created using the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a>
* API.</p> <p>You must specify either a template ID or a template name.</p>
*/
inline const Aws::String& GetLaunchTemplateName() const{ return m_launchTemplateName; }
/**
* <p>The name of the launch template. To get the template name, use the Amazon EC2
* <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html">DescribeLaunchTemplates</a>
* API operation. New launch templates can be created using the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a>
* API.</p> <p>You must specify either a template ID or a template name.</p>
*/
inline bool LaunchTemplateNameHasBeenSet() const { return m_launchTemplateNameHasBeenSet; }
/**
* <p>The name of the launch template. To get the template name, use the Amazon EC2
* <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html">DescribeLaunchTemplates</a>
* API operation. New launch templates can be created using the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a>
* API.</p> <p>You must specify either a template ID or a template name.</p>
*/
inline void SetLaunchTemplateName(const Aws::String& value) { m_launchTemplateNameHasBeenSet = true; m_launchTemplateName = value; }
/**
* <p>The name of the launch template. To get the template name, use the Amazon EC2
* <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html">DescribeLaunchTemplates</a>
* API operation. New launch templates can be created using the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a>
* API.</p> <p>You must specify either a template ID or a template name.</p>
*/
inline void SetLaunchTemplateName(Aws::String&& value) { m_launchTemplateNameHasBeenSet = true; m_launchTemplateName = std::move(value); }
/**
* <p>The name of the launch template. To get the template name, use the Amazon EC2
* <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html">DescribeLaunchTemplates</a>
* API operation. New launch templates can be created using the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a>
* API.</p> <p>You must specify either a template ID or a template name.</p>
*/
inline void SetLaunchTemplateName(const char* value) { m_launchTemplateNameHasBeenSet = true; m_launchTemplateName.assign(value); }
/**
* <p>The name of the launch template. To get the template name, use the Amazon EC2
* <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html">DescribeLaunchTemplates</a>
* API operation. New launch templates can be created using the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a>
* API.</p> <p>You must specify either a template ID or a template name.</p>
*/
inline LaunchTemplateSpecification& WithLaunchTemplateName(const Aws::String& value) { SetLaunchTemplateName(value); return *this;}
/**
* <p>The name of the launch template. To get the template name, use the Amazon EC2
* <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html">DescribeLaunchTemplates</a>
* API operation. New launch templates can be created using the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a>
* API.</p> <p>You must specify either a template ID or a template name.</p>
*/
inline LaunchTemplateSpecification& WithLaunchTemplateName(Aws::String&& value) { SetLaunchTemplateName(std::move(value)); return *this;}
/**
* <p>The name of the launch template. To get the template name, use the Amazon EC2
* <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html">DescribeLaunchTemplates</a>
* API operation. New launch templates can be created using the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a>
* API.</p> <p>You must specify either a template ID or a template name.</p>
*/
inline LaunchTemplateSpecification& WithLaunchTemplateName(const char* value) { SetLaunchTemplateName(value); return *this;}
/**
* <p>The version number, <code>$Latest</code>, or <code>$Default</code>. To get
* the version number, use the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplateVersions.html">DescribeLaunchTemplateVersions</a>
* API operation. New launch template versions can be created using the Amazon EC2
* <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplateVersion.html">CreateLaunchTemplateVersion</a>
* API.</p> <p>If the value is <code>$Latest</code>, Amazon EC2 Auto Scaling
* selects the latest version of the launch template when launching instances. If
* the value is <code>$Default</code>, Amazon EC2 Auto Scaling selects the default
* version of the launch template when launching instances. The default value is
* <code>$Default</code>.</p>
*/
inline const Aws::String& GetVersion() const{ return m_version; }
/**
* <p>The version number, <code>$Latest</code>, or <code>$Default</code>. To get
* the version number, use the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplateVersions.html">DescribeLaunchTemplateVersions</a>
* API operation. New launch template versions can be created using the Amazon EC2
* <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplateVersion.html">CreateLaunchTemplateVersion</a>
* API.</p> <p>If the value is <code>$Latest</code>, Amazon EC2 Auto Scaling
* selects the latest version of the launch template when launching instances. If
* the value is <code>$Default</code>, Amazon EC2 Auto Scaling selects the default
* version of the launch template when launching instances. The default value is
* <code>$Default</code>.</p>
*/
inline bool VersionHasBeenSet() const { return m_versionHasBeenSet; }
/**
* <p>The version number, <code>$Latest</code>, or <code>$Default</code>. To get
* the version number, use the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplateVersions.html">DescribeLaunchTemplateVersions</a>
* API operation. New launch template versions can be created using the Amazon EC2
* <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplateVersion.html">CreateLaunchTemplateVersion</a>
* API.</p> <p>If the value is <code>$Latest</code>, Amazon EC2 Auto Scaling
* selects the latest version of the launch template when launching instances. If
* the value is <code>$Default</code>, Amazon EC2 Auto Scaling selects the default
* version of the launch template when launching instances. The default value is
* <code>$Default</code>.</p>
*/
inline void SetVersion(const Aws::String& value) { m_versionHasBeenSet = true; m_version = value; }
/**
* <p>The version number, <code>$Latest</code>, or <code>$Default</code>. To get
* the version number, use the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplateVersions.html">DescribeLaunchTemplateVersions</a>
* API operation. New launch template versions can be created using the Amazon EC2
* <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplateVersion.html">CreateLaunchTemplateVersion</a>
* API.</p> <p>If the value is <code>$Latest</code>, Amazon EC2 Auto Scaling
* selects the latest version of the launch template when launching instances. If
* the value is <code>$Default</code>, Amazon EC2 Auto Scaling selects the default
* version of the launch template when launching instances. The default value is
* <code>$Default</code>.</p>
*/
inline void SetVersion(Aws::String&& value) { m_versionHasBeenSet = true; m_version = std::move(value); }
/**
* <p>The version number, <code>$Latest</code>, or <code>$Default</code>. To get
* the version number, use the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplateVersions.html">DescribeLaunchTemplateVersions</a>
* API operation. New launch template versions can be created using the Amazon EC2
* <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplateVersion.html">CreateLaunchTemplateVersion</a>
* API.</p> <p>If the value is <code>$Latest</code>, Amazon EC2 Auto Scaling
* selects the latest version of the launch template when launching instances. If
* the value is <code>$Default</code>, Amazon EC2 Auto Scaling selects the default
* version of the launch template when launching instances. The default value is
* <code>$Default</code>.</p>
*/
inline void SetVersion(const char* value) { m_versionHasBeenSet = true; m_version.assign(value); }
/**
* <p>The version number, <code>$Latest</code>, or <code>$Default</code>. To get
* the version number, use the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplateVersions.html">DescribeLaunchTemplateVersions</a>
* API operation. New launch template versions can be created using the Amazon EC2
* <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplateVersion.html">CreateLaunchTemplateVersion</a>
* API.</p> <p>If the value is <code>$Latest</code>, Amazon EC2 Auto Scaling
* selects the latest version of the launch template when launching instances. If
* the value is <code>$Default</code>, Amazon EC2 Auto Scaling selects the default
* version of the launch template when launching instances. The default value is
* <code>$Default</code>.</p>
*/
inline LaunchTemplateSpecification& WithVersion(const Aws::String& value) { SetVersion(value); return *this;}
/**
* <p>The version number, <code>$Latest</code>, or <code>$Default</code>. To get
* the version number, use the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplateVersions.html">DescribeLaunchTemplateVersions</a>
* API operation. New launch template versions can be created using the Amazon EC2
* <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplateVersion.html">CreateLaunchTemplateVersion</a>
* API.</p> <p>If the value is <code>$Latest</code>, Amazon EC2 Auto Scaling
* selects the latest version of the launch template when launching instances. If
* the value is <code>$Default</code>, Amazon EC2 Auto Scaling selects the default
* version of the launch template when launching instances. The default value is
* <code>$Default</code>.</p>
*/
inline LaunchTemplateSpecification& WithVersion(Aws::String&& value) { SetVersion(std::move(value)); return *this;}
/**
* <p>The version number, <code>$Latest</code>, or <code>$Default</code>. To get
* the version number, use the Amazon EC2 <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplateVersions.html">DescribeLaunchTemplateVersions</a>
* API operation. New launch template versions can be created using the Amazon EC2
* <a
* href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplateVersion.html">CreateLaunchTemplateVersion</a>
* API.</p> <p>If the value is <code>$Latest</code>, Amazon EC2 Auto Scaling
* selects the latest version of the launch template when launching instances. If
* the value is <code>$Default</code>, Amazon EC2 Auto Scaling selects the default
* version of the launch template when launching instances. The default value is
* <code>$Default</code>.</p>
*/
inline LaunchTemplateSpecification& WithVersion(const char* value) { SetVersion(value); return *this;}
private:
Aws::String m_launchTemplateId;
bool m_launchTemplateIdHasBeenSet;
Aws::String m_launchTemplateName;
bool m_launchTemplateNameHasBeenSet;
Aws::String m_version;
bool m_versionHasBeenSet;
};
} // namespace Model
} // namespace AutoScaling
} // namespace Aws