@Generated(value="software.amazon.awssdk:codegen") public final class CreateActivationRequest extends SsmRequest implements ToCopyableBuilder<CreateActivationRequest.Builder,CreateActivationRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateActivationRequest.Builder |
| 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)
Indicates whether some other object is "equal to" this one by SDK fields.
|
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)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
int |
hashCode() |
boolean |
hasRegistrationMetadata()
For responses, this returns true if the service returned a value for the RegistrationMetadata property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
String |
iamRole()
The name of 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<RegistrationMetadataItem> |
registrationMetadata()
Reserved for internal use.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateActivationRequest.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
Optional metadata that you assign to a resource.
|
CreateActivationRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationcopypublic 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.
Don't enter personally identifiable information in this field.
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.
Don't enter personally identifiable information in this field.
public final String iamRole()
The name of the Identity and Access Management (IAM) role that you want to assign to the managed instance. 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.
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.public final Integer registrationLimit()
Specify the maximum number of managed instances you want to register. The default value is 1.
1
.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.
public final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
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.
public final boolean hasRegistrationMetadata()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<RegistrationMetadataItem> registrationMetadata()
Reserved for internal use.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasRegistrationMetadata() method.
public CreateActivationRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<CreateActivationRequest.Builder,CreateActivationRequest>toBuilder in class SsmRequestpublic static CreateActivationRequest.Builder builder()
public static Class<? extends CreateActivationRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.