/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.simplesystemsmanagement.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateActivationRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* A user-defined description of the resource that you want to register with Systems Manager. *
** Don't enter personally identifiable information in this field. *
** 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. *
*
* 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 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. *
*
* Specify the maximum number of managed nodes you want to register. The default value is 1
.
*
* 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. *
*/ private java.util.Date expirationDate; /** ** 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. *
*/ private com.amazonaws.internal.SdkInternalList* Reserved for internal use. *
*/ private com.amazonaws.internal.SdkInternalList* A user-defined description of the resource that you want to register with Systems Manager. *
** Don't enter personally identifiable information in this field. *
** Don't enter personally identifiable information in this field. *
*/ public void setDescription(String description) { this.description = 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. *
** Don't enter personally identifiable information in this field. *
*/ public String getDescription() { return this.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. *
** Don't enter personally identifiable information in this field. *
* @return Returns a reference to this object so that method calls can be chained together. */ public CreateActivationRequest withDescription(String description) { setDescription(description); return this; } /** ** 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. *
** Don't enter personally identifiable information in this field. *
*/ public void setDefaultInstanceName(String defaultInstanceName) { this.defaultInstanceName = 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. *
** Don't enter personally identifiable information in this field. *
*/ public String getDefaultInstanceName() { return this.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. *
** Don't enter personally identifiable information in this field. *
* @return Returns a reference to this object so that method calls can be chained together. */ public CreateActivationRequest withDefaultInstanceName(String defaultInstanceName) { setDefaultInstanceName(defaultInstanceName); return this; } /** *
* 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 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. *
*ssm.amazonaws.com
. For more information, see Create an IAM
* service role for a hybrid 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. *
*/ public void setIamRole(String iamRole) { this.iamRole = 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 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. *
*ssm.amazonaws.com
. For more information, see Create an
* IAM service role for a hybrid 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. *
*/ public String getIamRole() { return this.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 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. *
*ssm.amazonaws.com
. For more information, see Create an IAM
* service role for a hybrid 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. *
* @return Returns a reference to this object so that method calls can be chained together. */ public CreateActivationRequest withIamRole(String iamRole) { setIamRole(iamRole); return this; } /** *
* Specify the maximum number of managed nodes you want to register. The default value is 1
.
*
1
.
*/
public void setRegistrationLimit(Integer registrationLimit) {
this.registrationLimit = registrationLimit;
}
/**
*
* Specify the maximum number of managed nodes you want to register. The default value is 1
.
*
1
.
*/
public Integer getRegistrationLimit() {
return this.registrationLimit;
}
/**
*
* Specify the maximum number of managed nodes you want to register. The default value is 1
.
*
1
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateActivationRequest withRegistrationLimit(Integer registrationLimit) {
setRegistrationLimit(registrationLimit);
return this;
}
/**
* * 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. *
* * @param 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. */ public void setExpirationDate(java.util.Date expirationDate) { this.expirationDate = 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. *
* * @return 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. */ public java.util.Date getExpirationDate() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateActivationRequest withExpirationDate(java.util.Date expirationDate) { setExpirationDate(expirationDate); return this; } /** ** 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. *
* * @return 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.
*/
public java.util.List
* 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:
*
*
*
* 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.
*
*
* Key=OS,Value=Windows
* Key=Environment,Value=Production
*
* 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.
*/
public void setTags(java.util.Collection
* 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:
*
*
*
* 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
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* Key=OS,Value=Windows
* Key=Environment,Value=Production
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateActivationRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new com.amazonaws.internal.SdkInternalList
* 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:
*
*
*
* 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.
*
*
* Key=OS,Value=Windows
* Key=Environment,Value=Production
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateActivationRequest withTags(java.util.Collection
* Reserved for internal use.
*
* Reserved for internal use.
*
* Reserved for internal use.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setRegistrationMetadata(java.util.Collection)} or {@link #withRegistrationMetadata(java.util.Collection)}
* if you want to override the existing values.
*
* Reserved for internal use.
*