AWS SDK for C++  1.8.100
AWS SDK for C++
Public Member Functions | List of all members
Aws::SSM::Model::CreateActivationRequest Class Reference

#include <CreateActivationRequest.h>

+ Inheritance diagram for Aws::SSM::Model::CreateActivationRequest:

Public Member Functions

 CreateActivationRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreateActivationRequestWithDescription (const Aws::String &value)
 
CreateActivationRequestWithDescription (Aws::String &&value)
 
CreateActivationRequestWithDescription (const char *value)
 
const Aws::StringGetDefaultInstanceName () const
 
bool DefaultInstanceNameHasBeenSet () const
 
void SetDefaultInstanceName (const Aws::String &value)
 
void SetDefaultInstanceName (Aws::String &&value)
 
void SetDefaultInstanceName (const char *value)
 
CreateActivationRequestWithDefaultInstanceName (const Aws::String &value)
 
CreateActivationRequestWithDefaultInstanceName (Aws::String &&value)
 
CreateActivationRequestWithDefaultInstanceName (const char *value)
 
const Aws::StringGetIamRole () const
 
bool IamRoleHasBeenSet () const
 
void SetIamRole (const Aws::String &value)
 
void SetIamRole (Aws::String &&value)
 
void SetIamRole (const char *value)
 
CreateActivationRequestWithIamRole (const Aws::String &value)
 
CreateActivationRequestWithIamRole (Aws::String &&value)
 
CreateActivationRequestWithIamRole (const char *value)
 
int GetRegistrationLimit () const
 
bool RegistrationLimitHasBeenSet () const
 
void SetRegistrationLimit (int value)
 
CreateActivationRequestWithRegistrationLimit (int value)
 
const Aws::Utils::DateTimeGetExpirationDate () const
 
bool ExpirationDateHasBeenSet () const
 
void SetExpirationDate (const Aws::Utils::DateTime &value)
 
void SetExpirationDate (Aws::Utils::DateTime &&value)
 
CreateActivationRequestWithExpirationDate (const Aws::Utils::DateTime &value)
 
CreateActivationRequestWithExpirationDate (Aws::Utils::DateTime &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateActivationRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateActivationRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateActivationRequestAddTags (const Tag &value)
 
CreateActivationRequestAddTags (Tag &&value)
 
- Public Member Functions inherited from Aws::SSM::SSMRequest
virtual ~SSMRequest ()
 
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 CreateActivationRequest.h.

Constructor & Destructor Documentation

◆ CreateActivationRequest()

Aws::SSM::Model::CreateActivationRequest::CreateActivationRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

CreateActivationRequest& Aws::SSM::Model::CreateActivationRequest::AddTags ( const Tag value)
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key name/value pairs:

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.

You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers and VMs after they connect to Systems Manager for the first time and are assigned a managed instance ID. This means they are listed in the AWS Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed instances, see AddTagsToResource. For information about how to remove tags from your managed instances, see RemoveTagsFromResource.

Definition at line 458 of file CreateActivationRequest.h.

◆ AddTags() [2/2]

CreateActivationRequest& Aws::SSM::Model::CreateActivationRequest::AddTags ( Tag &&  value)
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key name/value pairs:

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.

You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers and VMs after they connect to Systems Manager for the first time and are assigned a managed instance ID. This means they are listed in the AWS Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed instances, see AddTagsToResource. For information about how to remove tags from your managed instances, see RemoveTagsFromResource.

Definition at line 479 of file CreateActivationRequest.h.

◆ DefaultInstanceNameHasBeenSet()

bool Aws::SSM::Model::CreateActivationRequest::DefaultInstanceNameHasBeenSet ( ) const
inline

The name of the registered, managed instance as it will appear in the Systems Manager console or when you use the AWS command line tools to list Systems Manager resources.

Do not enter personally identifiable information in this field.

Definition at line 111 of file CreateActivationRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::SSM::Model::CreateActivationRequest::DescriptionHasBeenSet ( ) const
inline

A user-defined description of the resource that you want to register with Systems Manager.

Do not enter personally identifiable information in this field.

Definition at line 52 of file CreateActivationRequest.h.

◆ ExpirationDateHasBeenSet()

bool Aws::SSM::Model::CreateActivationRequest::ExpirationDateHasBeenSet ( ) const
inline

The date by which this activation request should expire. The default value is 24 hours.

Definition at line 286 of file CreateActivationRequest.h.

◆ GetDefaultInstanceName()

const Aws::String& Aws::SSM::Model::CreateActivationRequest::GetDefaultInstanceName ( ) const
inline

The name of the registered, managed instance as it will appear in the Systems Manager console or when you use the AWS command line tools to list Systems Manager resources.

Do not enter personally identifiable information in this field.

Definition at line 103 of file CreateActivationRequest.h.

◆ GetDescription()

const Aws::String& Aws::SSM::Model::CreateActivationRequest::GetDescription ( ) const
inline

A user-defined description of the resource that you want to register with Systems Manager.

Do not enter personally identifiable information in this field.

Definition at line 45 of file CreateActivationRequest.h.

◆ GetExpirationDate()

const Aws::Utils::DateTime& Aws::SSM::Model::CreateActivationRequest::GetExpirationDate ( ) const
inline

The date by which this activation request should expire. The default value is 24 hours.

Definition at line 280 of file CreateActivationRequest.h.

◆ GetIamRole()

const Aws::String& Aws::SSM::Model::CreateActivationRequest::GetIamRole ( ) const
inline

The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance. This IAM role must provide AssumeRole permissions for the Systems Manager service principal ssm.amazonaws.com. For more information, see Create an IAM service role for a hybrid environment in the AWS Systems Manager User Guide.

Definition at line 171 of file CreateActivationRequest.h.

◆ GetRegistrationLimit()

int Aws::SSM::Model::CreateActivationRequest::GetRegistrationLimit ( ) const
inline

Specify the maximum number of managed instances you want to register. The default value is 1 instance.

Definition at line 255 of file CreateActivationRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SSM::Model::CreateActivationRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::SSM::SSMRequest.

◆ GetServiceRequestName()

virtual const char* Aws::SSM::Model::CreateActivationRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file CreateActivationRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::SSM::Model::CreateActivationRequest::GetTags ( ) const
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key name/value pairs:

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.

You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers and VMs after they connect to Systems Manager for the first time and are assigned a managed instance ID. This means they are listed in the AWS Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed instances, see AddTagsToResource. For information about how to remove tags from your managed instances, see RemoveTagsFromResource.

Definition at line 332 of file CreateActivationRequest.h.

◆ IamRoleHasBeenSet()

bool Aws::SSM::Model::CreateActivationRequest::IamRoleHasBeenSet ( ) const
inline

The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance. This IAM role must provide AssumeRole permissions for the Systems Manager service principal ssm.amazonaws.com. For more information, see Create an IAM service role for a hybrid environment in the AWS Systems Manager User Guide.

Definition at line 182 of file CreateActivationRequest.h.

◆ RegistrationLimitHasBeenSet()

bool Aws::SSM::Model::CreateActivationRequest::RegistrationLimitHasBeenSet ( ) const
inline

Specify the maximum number of managed instances you want to register. The default value is 1 instance.

Definition at line 261 of file CreateActivationRequest.h.

◆ SerializePayload()

Aws::String Aws::SSM::Model::CreateActivationRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDefaultInstanceName() [1/3]

void Aws::SSM::Model::CreateActivationRequest::SetDefaultInstanceName ( const Aws::String value)
inline

The name of the registered, managed instance as it will appear in the Systems Manager console or when you use the AWS command line tools to list Systems Manager resources.

Do not enter personally identifiable information in this field.

Definition at line 119 of file CreateActivationRequest.h.

◆ SetDefaultInstanceName() [2/3]

void Aws::SSM::Model::CreateActivationRequest::SetDefaultInstanceName ( Aws::String &&  value)
inline

The name of the registered, managed instance as it will appear in the Systems Manager console or when you use the AWS command line tools to list Systems Manager resources.

Do not enter personally identifiable information in this field.

Definition at line 127 of file CreateActivationRequest.h.

◆ SetDefaultInstanceName() [3/3]

void Aws::SSM::Model::CreateActivationRequest::SetDefaultInstanceName ( const char *  value)
inline

The name of the registered, managed instance as it will appear in the Systems Manager console or when you use the AWS command line tools to list Systems Manager resources.

Do not enter personally identifiable information in this field.

Definition at line 135 of file CreateActivationRequest.h.

◆ SetDescription() [1/3]

void Aws::SSM::Model::CreateActivationRequest::SetDescription ( const Aws::String value)
inline

A user-defined description of the resource that you want to register with Systems Manager.

Do not enter personally identifiable information in this field.

Definition at line 59 of file CreateActivationRequest.h.

◆ SetDescription() [2/3]

void Aws::SSM::Model::CreateActivationRequest::SetDescription ( Aws::String &&  value)
inline

A user-defined description of the resource that you want to register with Systems Manager.

Do not enter personally identifiable information in this field.

Definition at line 66 of file CreateActivationRequest.h.

◆ SetDescription() [3/3]

void Aws::SSM::Model::CreateActivationRequest::SetDescription ( const char *  value)
inline

A user-defined description of the resource that you want to register with Systems Manager.

Do not enter personally identifiable information in this field.

Definition at line 73 of file CreateActivationRequest.h.

◆ SetExpirationDate() [1/2]

void Aws::SSM::Model::CreateActivationRequest::SetExpirationDate ( const Aws::Utils::DateTime value)
inline

The date by which this activation request should expire. The default value is 24 hours.

Definition at line 292 of file CreateActivationRequest.h.

◆ SetExpirationDate() [2/2]

void Aws::SSM::Model::CreateActivationRequest::SetExpirationDate ( Aws::Utils::DateTime &&  value)
inline

The date by which this activation request should expire. The default value is 24 hours.

Definition at line 298 of file CreateActivationRequest.h.

◆ SetIamRole() [1/3]

void Aws::SSM::Model::CreateActivationRequest::SetIamRole ( const Aws::String value)
inline

The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance. This IAM role must provide AssumeRole permissions for the Systems Manager service principal ssm.amazonaws.com. For more information, see Create an IAM service role for a hybrid environment in the AWS Systems Manager User Guide.

Definition at line 193 of file CreateActivationRequest.h.

◆ SetIamRole() [2/3]

void Aws::SSM::Model::CreateActivationRequest::SetIamRole ( Aws::String &&  value)
inline

The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance. This IAM role must provide AssumeRole permissions for the Systems Manager service principal ssm.amazonaws.com. For more information, see Create an IAM service role for a hybrid environment in the AWS Systems Manager User Guide.

Definition at line 204 of file CreateActivationRequest.h.

◆ SetIamRole() [3/3]

void Aws::SSM::Model::CreateActivationRequest::SetIamRole ( const char *  value)
inline

The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance. This IAM role must provide AssumeRole permissions for the Systems Manager service principal ssm.amazonaws.com. For more information, see Create an IAM service role for a hybrid environment in the AWS Systems Manager User Guide.

Definition at line 215 of file CreateActivationRequest.h.

◆ SetRegistrationLimit()

void Aws::SSM::Model::CreateActivationRequest::SetRegistrationLimit ( int  value)
inline

Specify the maximum number of managed instances you want to register. The default value is 1 instance.

Definition at line 267 of file CreateActivationRequest.h.

◆ SetTags() [1/2]

void Aws::SSM::Model::CreateActivationRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key name/value pairs:

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.

You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers and VMs after they connect to Systems Manager for the first time and are assigned a managed instance ID. This means they are listed in the AWS Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed instances, see AddTagsToResource. For information about how to remove tags from your managed instances, see RemoveTagsFromResource.

Definition at line 374 of file CreateActivationRequest.h.

◆ SetTags() [2/2]

void Aws::SSM::Model::CreateActivationRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key name/value pairs:

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.

You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers and VMs after they connect to Systems Manager for the first time and are assigned a managed instance ID. This means they are listed in the AWS Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed instances, see AddTagsToResource. For information about how to remove tags from your managed instances, see RemoveTagsFromResource.

Definition at line 395 of file CreateActivationRequest.h.

◆ TagsHasBeenSet()

bool Aws::SSM::Model::CreateActivationRequest::TagsHasBeenSet ( ) const
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key name/value pairs:

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.

You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers and VMs after they connect to Systems Manager for the first time and are assigned a managed instance ID. This means they are listed in the AWS Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed instances, see AddTagsToResource. For information about how to remove tags from your managed instances, see RemoveTagsFromResource.

Definition at line 353 of file CreateActivationRequest.h.

◆ WithDefaultInstanceName() [1/3]

CreateActivationRequest& Aws::SSM::Model::CreateActivationRequest::WithDefaultInstanceName ( const Aws::String value)
inline

The name of the registered, managed instance as it will appear in the Systems Manager console or when you use the AWS command line tools to list Systems Manager resources.

Do not enter personally identifiable information in this field.

Definition at line 143 of file CreateActivationRequest.h.

◆ WithDefaultInstanceName() [2/3]

CreateActivationRequest& Aws::SSM::Model::CreateActivationRequest::WithDefaultInstanceName ( Aws::String &&  value)
inline

The name of the registered, managed instance as it will appear in the Systems Manager console or when you use the AWS command line tools to list Systems Manager resources.

Do not enter personally identifiable information in this field.

Definition at line 151 of file CreateActivationRequest.h.

◆ WithDefaultInstanceName() [3/3]

CreateActivationRequest& Aws::SSM::Model::CreateActivationRequest::WithDefaultInstanceName ( const char *  value)
inline

The name of the registered, managed instance as it will appear in the Systems Manager console or when you use the AWS command line tools to list Systems Manager resources.

Do not enter personally identifiable information in this field.

Definition at line 159 of file CreateActivationRequest.h.

◆ WithDescription() [1/3]

CreateActivationRequest& Aws::SSM::Model::CreateActivationRequest::WithDescription ( const Aws::String value)
inline

A user-defined description of the resource that you want to register with Systems Manager.

Do not enter personally identifiable information in this field.

Definition at line 80 of file CreateActivationRequest.h.

◆ WithDescription() [2/3]

CreateActivationRequest& Aws::SSM::Model::CreateActivationRequest::WithDescription ( Aws::String &&  value)
inline

A user-defined description of the resource that you want to register with Systems Manager.

Do not enter personally identifiable information in this field.

Definition at line 87 of file CreateActivationRequest.h.

◆ WithDescription() [3/3]

CreateActivationRequest& Aws::SSM::Model::CreateActivationRequest::WithDescription ( const char *  value)
inline

A user-defined description of the resource that you want to register with Systems Manager.

Do not enter personally identifiable information in this field.

Definition at line 94 of file CreateActivationRequest.h.

◆ WithExpirationDate() [1/2]

CreateActivationRequest& Aws::SSM::Model::CreateActivationRequest::WithExpirationDate ( const Aws::Utils::DateTime value)
inline

The date by which this activation request should expire. The default value is 24 hours.

Definition at line 304 of file CreateActivationRequest.h.

◆ WithExpirationDate() [2/2]

CreateActivationRequest& Aws::SSM::Model::CreateActivationRequest::WithExpirationDate ( Aws::Utils::DateTime &&  value)
inline

The date by which this activation request should expire. The default value is 24 hours.

Definition at line 310 of file CreateActivationRequest.h.

◆ WithIamRole() [1/3]

CreateActivationRequest& Aws::SSM::Model::CreateActivationRequest::WithIamRole ( const Aws::String value)
inline

The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance. This IAM role must provide AssumeRole permissions for the Systems Manager service principal ssm.amazonaws.com. For more information, see Create an IAM service role for a hybrid environment in the AWS Systems Manager User Guide.

Definition at line 226 of file CreateActivationRequest.h.

◆ WithIamRole() [2/3]

CreateActivationRequest& Aws::SSM::Model::CreateActivationRequest::WithIamRole ( Aws::String &&  value)
inline

The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance. This IAM role must provide AssumeRole permissions for the Systems Manager service principal ssm.amazonaws.com. For more information, see Create an IAM service role for a hybrid environment in the AWS Systems Manager User Guide.

Definition at line 237 of file CreateActivationRequest.h.

◆ WithIamRole() [3/3]

CreateActivationRequest& Aws::SSM::Model::CreateActivationRequest::WithIamRole ( const char *  value)
inline

The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance. This IAM role must provide AssumeRole permissions for the Systems Manager service principal ssm.amazonaws.com. For more information, see Create an IAM service role for a hybrid environment in the AWS Systems Manager User Guide.

Definition at line 248 of file CreateActivationRequest.h.

◆ WithRegistrationLimit()

CreateActivationRequest& Aws::SSM::Model::CreateActivationRequest::WithRegistrationLimit ( int  value)
inline

Specify the maximum number of managed instances you want to register. The default value is 1 instance.

Definition at line 273 of file CreateActivationRequest.h.

◆ WithTags() [1/2]

CreateActivationRequest& Aws::SSM::Model::CreateActivationRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key name/value pairs:

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.

You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers and VMs after they connect to Systems Manager for the first time and are assigned a managed instance ID. This means they are listed in the AWS Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed instances, see AddTagsToResource. For information about how to remove tags from your managed instances, see RemoveTagsFromResource.

Definition at line 416 of file CreateActivationRequest.h.

◆ WithTags() [2/2]

CreateActivationRequest& Aws::SSM::Model::CreateActivationRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key name/value pairs:

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.

You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers and VMs after they connect to Systems Manager for the first time and are assigned a managed instance ID. This means they are listed in the AWS Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed instances, see AddTagsToResource. For information about how to remove tags from your managed instances, see RemoveTagsFromResource.

Definition at line 437 of file CreateActivationRequest.h.


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