com.amazonaws.services.simplesystemsmanagement.model

Class CreateActivationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simplesystemsmanagement.model.CreateActivationRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateActivationRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateActivationRequest()

Method Summary

Modifier and Type	Method and Description
CreateActivationRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDefaultInstanceName() The name of the registered, managed node as it will appear in the Amazon Web Services Systems Manager console or when you use the Amazon Web Services command line tools to list Systems Manager resources.
String	getDescription() A user-defined description of the resource that you want to register with Systems Manager.
Date	getExpirationDate() The date by which this activation request should expire, in timestamp format, such as "2021-07-07T00:00:00".
String	getIamRole() The name of the Identity and Access Management (IAM) role that you want to assign to the managed node.
Integer	getRegistrationLimit() Specify the maximum number of managed nodes you want to register.
List<RegistrationMetadataItem>	getRegistrationMetadata() Reserved for internal use.
List<Tag>	getTags() Optional metadata that you assign to a resource.
int	hashCode()
void	setDefaultInstanceName(String defaultInstanceName) The name of the registered, managed node as it will appear in the Amazon Web Services Systems Manager console or when you use the Amazon Web Services command line tools to list Systems Manager resources.
void	setDescription(String description) A user-defined description of the resource that you want to register with Systems Manager.
void	setExpirationDate(Date expirationDate) The date by which this activation request should expire, in timestamp format, such as "2021-07-07T00:00:00".
void	setIamRole(String iamRole) The name of the Identity and Access Management (IAM) role that you want to assign to the managed node.
void	setRegistrationLimit(Integer registrationLimit) Specify the maximum number of managed nodes you want to register.
void	setRegistrationMetadata(Collection<RegistrationMetadataItem> registrationMetadata) Reserved for internal use.
void	setTags(Collection<Tag> tags) Optional metadata that you assign to a resource.
String	toString() Returns a string representation of this object.
CreateActivationRequest	withDefaultInstanceName(String defaultInstanceName) The name of the registered, managed node as it will appear in the Amazon Web Services Systems Manager console or when you use the Amazon Web Services command line tools to list Systems Manager resources.
CreateActivationRequest	withDescription(String description) A user-defined description of the resource that you want to register with Systems Manager.
CreateActivationRequest	withExpirationDate(Date expirationDate) The date by which this activation request should expire, in timestamp format, such as "2021-07-07T00:00:00".
CreateActivationRequest	withIamRole(String iamRole) The name of the Identity and Access Management (IAM) role that you want to assign to the managed node.
CreateActivationRequest	withRegistrationLimit(Integer registrationLimit) Specify the maximum number of managed nodes you want to register.
CreateActivationRequest	withRegistrationMetadata(Collection<RegistrationMetadataItem> registrationMetadata) Reserved for internal use.
CreateActivationRequest	withRegistrationMetadata(RegistrationMetadataItem... registrationMetadata) Reserved for internal use.
CreateActivationRequest	withTags(Collection<Tag> tags) Optional metadata that you assign to a resource.
CreateActivationRequest	withTags(Tag... tags) Optional metadata that you assign to a resource.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateActivationRequest

public CreateActivationRequest()

Method Detail

setDescription

public void setDescription(String description)

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

Don't enter personally identifiable information in this field.

Parameters:

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

Don't enter personally identifiable information in this field.

getDescription

public String getDescription()

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

Don't enter personally identifiable information in this field.

Returns:

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

Don't enter personally identifiable information in this field.

withDescription

public CreateActivationRequest withDescription(String description)

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

Don't enter personally identifiable information in this field.

Parameters:

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

Don't enter personally identifiable information in this field.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDefaultInstanceName

public void setDefaultInstanceName(String defaultInstanceName)

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

Don't enter personally identifiable information in this field.

Parameters:

defaultInstanceName - The name of the registered, managed node as it will appear in the Amazon Web Services Systems Manager console or when you use the Amazon Web Services command line tools to list Systems Manager resources.

Don't enter personally identifiable information in this field.

getDefaultInstanceName

public String getDefaultInstanceName()

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

Don't enter personally identifiable information in this field.

Returns:

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

Don't enter personally identifiable information in this field.

withDefaultInstanceName

public CreateActivationRequest withDefaultInstanceName(String defaultInstanceName)

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

Don't enter personally identifiable information in this field.

Parameters:

defaultInstanceName - The name of the registered, managed node as it will appear in the Amazon Web Services Systems Manager console or when you use the Amazon Web Services command line tools to list Systems Manager resources.

Don't enter personally identifiable information in this field.

Returns:

Returns a reference to this object so that method calls can be chained together.

setIamRole

public void setIamRole(String iamRole)

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

You can't specify an IAM service-linked role for this parameter. You must create a unique role.

Parameters:

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

You can't specify an IAM service-linked role for this parameter. You must create a unique role.

getIamRole

public String getIamRole()

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

You can't specify an IAM service-linked role for this parameter. You must create a unique role.

Returns:

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

You can't specify an IAM service-linked role for this parameter. You must create a unique role.

withIamRole

public CreateActivationRequest withIamRole(String iamRole)

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

You can't specify an IAM service-linked role for this parameter. You must create a unique role.

Parameters:

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

You can't specify an IAM service-linked role for this parameter. You must create a unique role.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRegistrationLimit

public void setRegistrationLimit(Integer registrationLimit)

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

Parameters:

registrationLimit - Specify the maximum number of managed nodes you want to register. The default value is 1.

getRegistrationLimit

public Integer getRegistrationLimit()

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

Returns:

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

withRegistrationLimit

public CreateActivationRequest withRegistrationLimit(Integer registrationLimit)

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

Parameters:

registrationLimit - Specify the maximum number of managed nodes you want to register. The default value is 1.

Returns:

Returns a reference to this object so that method calls can be chained together.

setExpirationDate

public void setExpirationDate(Date expirationDate)

The date by which this activation request should expire, in timestamp format, such as "2021-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours.

Parameters:

expirationDate - The date by which this activation request should expire, in timestamp format, such as "2021-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours.

getExpirationDate

public Date getExpirationDate()

The date by which this activation request should expire, in timestamp format, such as "2021-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours.

Returns:

The date by which this activation request should expire, in timestamp format, such as "2021-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours.

withExpirationDate

public CreateActivationRequest withExpirationDate(Date expirationDate)

The date by which this activation request should expire, in timestamp format, such as "2021-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours.

Parameters:

expirationDate - The date by which this activation request should expire, in timestamp format, such as "2021-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

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-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, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.

Returns:

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-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, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.

setTags

public void setTags(Collection<Tag> tags)

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-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, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.

Parameters:

tags - 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-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, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.

withTags

public CreateActivationRequest withTags(Tag... tags)

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-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, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - 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-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, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateActivationRequest withTags(Collection<Tag> tags)

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-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, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.

Parameters:

tags - 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-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, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.

Returns:

Returns a reference to this object so that method calls can be chained together.

getRegistrationMetadata

public List<RegistrationMetadataItem> getRegistrationMetadata()

Reserved for internal use.

Returns:

Reserved for internal use.

setRegistrationMetadata

public void setRegistrationMetadata(Collection<RegistrationMetadataItem> registrationMetadata)

Reserved for internal use.

Parameters:

registrationMetadata - Reserved for internal use.

withRegistrationMetadata

public CreateActivationRequest withRegistrationMetadata(RegistrationMetadataItem... registrationMetadata)

Reserved for internal use.

NOTE: This method appends the values to the existing list (if any). Use setRegistrationMetadata(java.util.Collection) or withRegistrationMetadata(java.util.Collection) if you want to override the existing values.

Parameters:

registrationMetadata - Reserved for internal use.

Returns:

Returns a reference to this object so that method calls can be chained together.

withRegistrationMetadata

public CreateActivationRequest withRegistrationMetadata(Collection<RegistrationMetadataItem> registrationMetadata)

Reserved for internal use.

Parameters:

registrationMetadata - Reserved for internal use.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateActivationRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()