software.amazon.awssdk.services.licensemanager.model

Class CreateTokenRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.licensemanager.model.LicenseManagerRequest

software.amazon.awssdk.services.licensemanager.model.CreateTokenRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateTokenRequest.Builder,CreateTokenRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateTokenRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateTokenRequest.Builder	builder()
String	clientToken() Idempotency token, valid for 10 minutes.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	expirationInDays() Token expiration, in days, counted from token creation.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRoleArns() For responses, this returns true if the service returned a value for the RoleArns property.
boolean	hasTokenProperties() For responses, this returns true if the service returned a value for the TokenProperties property.
String	licenseArn() Amazon Resource Name (ARN) of the license.
List<String>	roleArns() Amazon Resource Name (ARN) of the IAM roles to embed in the token.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateTokenRequest.Builder>	serializableBuilderClass()
CreateTokenRequest.Builder	toBuilder()
List<String>	tokenProperties() Data specified by the caller to be included in the JWT token.
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

licenseArn

public final String licenseArn()

Amazon Resource Name (ARN) of the license. The ARN is mapped to the aud claim of the JWT token.

Returns:

Amazon Resource Name (ARN) of the license. The ARN is mapped to the aud claim of the JWT token.

hasRoleArns

public final boolean hasRoleArns()

For responses, this returns true if the service returned a value for the RoleArns property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

roleArns

public final List<String> roleArns()

Amazon Resource Name (ARN) of the IAM roles to embed in the token. License Manager does not check whether the roles are in 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 hasRoleArns() method.

Returns:

Amazon Resource Name (ARN) of the IAM roles to embed in the token. License Manager does not check whether the roles are in use.

expirationInDays

public final Integer expirationInDays()

Token expiration, in days, counted from token creation. The default is 365 days.

Returns:

Token expiration, in days, counted from token creation. The default is 365 days.

hasTokenProperties

public final boolean hasTokenProperties()

For responses, this returns true if the service returned a value for the TokenProperties property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

tokenProperties

public final List<String> tokenProperties()

Data specified by the caller to be included in the JWT token. The data is mapped to the amr claim of the JWT token.

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 hasTokenProperties() method.

Returns:

Data specified by the caller to be included in the JWT token. The data is mapped to the amr claim of the JWT token.

clientToken

public final String clientToken()

Idempotency token, valid for 10 minutes.

Returns:

Idempotency token, valid for 10 minutes.

toBuilder

public CreateTokenRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateTokenRequest.Builder,CreateTokenRequest>

Specified by:

toBuilder in class LicenseManagerRequest

builder

public static CreateTokenRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateTokenRequest.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