software.amazon.awssdk.services.ssm.model

Class CreateActivationRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssm.model.SsmRequest

software.amazon.awssdk.services.ssm.model.CreateActivationRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateActivationRequest.Builder,CreateActivationRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateActivationRequest
extends SsmRequest
implements ToCopyableBuilder<CreateActivationRequest.Builder,CreateActivationRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateActivationRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateActivationRequest.Builder	builder()
String	defaultInstanceName() The name of the registered, managed instance 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	description() A user-defined description of the resource that you want to register with Systems Manager.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Instant	expirationDate() The date by which this activation request should expire, in timestamp format, such as "2021-07-07T00:00:00".
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	iamRole() The Identity and Access Management (IAM) role that you want to assign to the managed instance.
Integer	registrationLimit() Specify the maximum number of managed instances you want to register.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateActivationRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() Optional metadata that you assign to a resource.
CreateActivationRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

description

public final 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.

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.

defaultInstanceName

public final String defaultInstanceName()

The name of the registered, managed instance 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 instance 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.

iamRole

public final String iamRole()

The Identity and Access Management (IAM) role that you want to assign to the managed instance. This IAMrole 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.

Returns:

The Identity and Access Management (IAM) role that you want to assign to the managed instance. This IAMrole 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.

registrationLimit

public final Integer registrationLimit()

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

Returns:

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

expirationDate

public final Instant 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:

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.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final List<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 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 Amazon Web Services 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

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 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 Amazon Web Services 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.

toBuilder

public CreateActivationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateActivationRequest.Builder,CreateActivationRequest>

Specified by:

toBuilder in class SsmRequest

builder

public static CreateActivationRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateActivationRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo