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("software.amazon.awssdk:codegen") public final class CreateActivationRequest extends SsmRequest implements ToCopyableBuilder<CreateActivationRequest.Builder,CreateActivationRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CreateActivationRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateActivationRequest.Builder
builder()
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.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
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 node.Integer
registrationLimit()
Specify the maximum number of managed nodes 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()
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 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.
-
iamRole
public final 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.
- 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.
-
registrationLimit
public final Integer registrationLimit()
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
.
-
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()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
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, 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.
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.- 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.
-
-
-
hasRegistrationMetadata
public final boolean hasRegistrationMetadata()
For responses, this returns true if the service returned a value for the RegistrationMetadata property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
registrationMetadata
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.- Returns:
- Reserved for internal use.
-
toBuilder
public CreateActivationRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateActivationRequest.Builder,CreateActivationRequest>
- Specified by:
toBuilder
in classSsmRequest
-
builder
public static CreateActivationRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateActivationRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-