software.amazon.awssdk.services.licensemanager.model

Class CreateLicenseConfigurationRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateLicenseConfigurationRequest.Builder,CreateLicenseConfigurationRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateLicenseConfigurationRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateLicenseConfigurationRequest.Builder	builder()
String	description() Description of the license configuration.
Boolean	disassociateWhenNotFound() When true, disassociates a resource when software is uninstalled.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLicenseRules() For responses, this returns true if the service returned a value for the LicenseRules property.
boolean	hasProductInformationList() For responses, this returns true if the service returned a value for the ProductInformationList property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
Long	licenseCount() Number of licenses managed by the license configuration.
Boolean	licenseCountHardLimit() Indicates whether hard or soft license enforcement is used.
LicenseCountingType	licenseCountingType() Dimension used to track the license inventory.
String	licenseCountingTypeAsString() Dimension used to track the license inventory.
List<String>	licenseRules() License rules.
String	name() Name of the license configuration.
List<ProductInformation>	productInformationList() Product information.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateLicenseConfigurationRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() Tags to add to the license configuration.
CreateLicenseConfigurationRequest.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()

Name of the license configuration.

Returns:

Name of the license configuration.

description

public final String description()

Description of the license configuration.

Returns:

Description of the license configuration.

licenseCountingType

public final LicenseCountingType licenseCountingType()

Dimension used to track the license inventory.

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

Returns:

Dimension used to track the license inventory.

See Also:

LicenseCountingType

licenseCountingTypeAsString

public final String licenseCountingTypeAsString()

Dimension used to track the license inventory.

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

Returns:

Dimension used to track the license inventory.

See Also:

LicenseCountingType

licenseCount

public final Long licenseCount()

Number of licenses managed by the license configuration.

Returns:

Number of licenses managed by the license configuration.

licenseCountHardLimit

public final Boolean licenseCountHardLimit()

Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new instances.

Returns:

Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new instances.

hasLicenseRules

public final boolean hasLicenseRules()

For responses, this returns true if the service returned a value for the LicenseRules 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.

licenseRules

public final List<String> licenseRules()

License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). The available rules vary by dimension, as follows.

• Cores dimension: allowedTenancy | licenseAffinityToHost | maximumCores | minimumCores

• Instances dimension: allowedTenancy | maximumCores | minimumCores | maximumSockets | minimumSockets | maximumVcpus | minimumVcpus

• Sockets dimension: allowedTenancy | licenseAffinityToHost | maximumSockets | minimumSockets

• vCPUs dimension: allowedTenancy | honorVcpuOptimization | maximumVcpus | minimumVcpus

The unit for licenseAffinityToHost is days and the range is 1 to 180. The possible values for allowedTenancy are EC2-Default, EC2-DedicatedHost, and EC2-DedicatedInstance. The possible values for honorVcpuOptimization are True and False.

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

Returns:

License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). The available rules vary by dimension, as follows.

• Cores dimension: allowedTenancy | licenseAffinityToHost | maximumCores | minimumCores

• Instances dimension: allowedTenancy | maximumCores | minimumCores | maximumSockets | minimumSockets | maximumVcpus | minimumVcpus

• Sockets dimension: allowedTenancy | licenseAffinityToHost | maximumSockets | minimumSockets

• vCPUs dimension: allowedTenancy | honorVcpuOptimization | maximumVcpus | minimumVcpus

The unit for licenseAffinityToHost is days and the range is 1 to 180. The possible values for allowedTenancy are EC2-Default, EC2-DedicatedHost, and EC2-DedicatedInstance. The possible values for honorVcpuOptimization are True and False.

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 List<Tag> tags()

Tags to add to the license configuration.

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:

Tags to add to the license configuration.

disassociateWhenNotFound

public final Boolean disassociateWhenNotFound()

When true, disassociates a resource when software is uninstalled.

Returns:

When true, disassociates a resource when software is uninstalled.

hasProductInformationList

public final boolean hasProductInformationList()

For responses, this returns true if the service returned a value for the ProductInformationList 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.

productInformationList

public final List<ProductInformation> productInformationList()

Product information.

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

Returns:

Product information.

toBuilder

public CreateLicenseConfigurationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateLicenseConfigurationRequest.Builder,CreateLicenseConfigurationRequest>

Specified by:

toBuilder in class LicenseManagerRequest

builder

public static CreateLicenseConfigurationRequest.Builder builder()

serializableBuilderClass

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