Package software.amazon.awssdk.services.eks.model

Class CreateEksAnywhereSubscriptionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.eks.model.EksRequest

software.amazon.awssdk.services.eks.model.CreateEksAnywhereSubscriptionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateEksAnywhereSubscriptionRequest.Builder,CreateEksAnywhereSubscriptionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateEksAnywhereSubscriptionRequest
extends EksRequest
implements ToCopyableBuilder<CreateEksAnywhereSubscriptionRequest.Builder,CreateEksAnywhereSubscriptionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateEksAnywhereSubscriptionRequest.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	autoRenew()	A boolean indicating whether the subscription auto renews at the end of the term.
static CreateEksAnywhereSubscriptionRequest.Builder	builder()
String	clientRequestToken()	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
Integer	licenseQuantity()	The number of licenses to purchase with the subscription.
EksAnywhereSubscriptionLicenseType	licenseType()	The license type for all licenses in the subscription.
String	licenseTypeAsString()	The license type for all licenses in the subscription.
String	name()	The unique name for your subscription.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateEksAnywhereSubscriptionRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	The metadata for a subscription to assist with categorization and organization.
EksAnywhereSubscriptionTerm	term()	An object representing the term duration and term unit type of your subscription.
CreateEksAnywhereSubscriptionRequest.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

name

public final String name()

The unique name for your subscription. It must be unique in your Amazon Web Services account in the Amazon Web Services Region you're creating the subscription in. The name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores. It must start with an alphabetic character and can't be longer than 100 characters.

Returns:

The unique name for your subscription. It must be unique in your Amazon Web Services account in the Amazon Web Services Region you're creating the subscription in. The name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores. It must start with an alphabetic character and can't be longer than 100 characters.

term

public final EksAnywhereSubscriptionTerm term()

An object representing the term duration and term unit type of your subscription. This determines the term length of your subscription. Valid values are MONTHS for term unit and 12 or 36 for term duration, indicating a 12 month or 36 month subscription. This value cannot be changed after creating the subscription.

Returns:

An object representing the term duration and term unit type of your subscription. This determines the term length of your subscription. Valid values are MONTHS for term unit and 12 or 36 for term duration, indicating a 12 month or 36 month subscription. This value cannot be changed after creating the subscription.

licenseQuantity

public final Integer licenseQuantity()

The number of licenses to purchase with the subscription. Valid values are between 1 and 100. This value can't be changed after creating the subscription.

Returns:

The number of licenses to purchase with the subscription. Valid values are between 1 and 100. This value can't be changed after creating the subscription.

licenseType

public final EksAnywhereSubscriptionLicenseType licenseType()

The license type for all licenses in the subscription. Valid value is CLUSTER. With the CLUSTER license type, each license covers support for a single EKS Anywhere cluster.

If the service returns an enum value that is not available in the current SDK version, licenseType will return EksAnywhereSubscriptionLicenseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from licenseTypeAsString().

Returns:

The license type for all licenses in the subscription. Valid value is CLUSTER. With the CLUSTER license type, each license covers support for a single EKS Anywhere cluster.

See Also:

EksAnywhereSubscriptionLicenseType

licenseTypeAsString

public final String licenseTypeAsString()

The license type for all licenses in the subscription. Valid value is CLUSTER. With the CLUSTER license type, each license covers support for a single EKS Anywhere cluster.

If the service returns an enum value that is not available in the current SDK version, licenseType will return EksAnywhereSubscriptionLicenseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from licenseTypeAsString().

Returns:

The license type for all licenses in the subscription. Valid value is CLUSTER. With the CLUSTER license type, each license covers support for a single EKS Anywhere cluster.

See Also:

EksAnywhereSubscriptionLicenseType

autoRenew

public final Boolean autoRenew()

A boolean indicating whether the subscription auto renews at the end of the term.

Returns:

A boolean indicating whether the subscription auto renews at the end of the term.

clientRequestToken

public final String clientRequestToken()

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

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

tags

public final Map<String,String> tags()

The metadata for a subscription to assist with categorization and organization. Each tag consists of a key and an optional value. Subscription tags don't propagate to any other resources associated with the subscription.

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:

The metadata for a subscription to assist with categorization and organization. Each tag consists of a key and an optional value. Subscription tags don't propagate to any other resources associated with the subscription.

toBuilder

public CreateEksAnywhereSubscriptionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateEksAnywhereSubscriptionRequest.Builder,CreateEksAnywhereSubscriptionRequest>

Specified by:

toBuilder in class EksRequest

builder

public static CreateEksAnywhereSubscriptionRequest.Builder builder()

serializableBuilderClass

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