software.amazon.awssdk.services.licensemanager.model

Class LicenseConfiguration

java.lang.Object

software.amazon.awssdk.services.licensemanager.model.LicenseConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<LicenseConfiguration.Builder,LicenseConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class LicenseConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LicenseConfiguration.Builder,LicenseConfiguration>

A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or VCPU), tenancy (shared tenancy, Amazon EC2 Dedicated Instance, Amazon EC2 Dedicated Host, or any of these), host affinity (how long a VM must be associated with a host), the number of licenses purchased and used.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LicenseConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static LicenseConfiguration.Builder	builder()
Long	consumedLicenses() Number of licenses consumed.
List<ConsumedLicenseSummary>	consumedLicenseSummaryList() List of summaries for licenses consumed by various resources.
String	description() Description of the license configuration.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	licenseConfigurationArn() ARN of the LicenseConfiguration object.
String	licenseConfigurationId() Unique ID of the LicenseConfiguration object.
Long	licenseCount() Number of licenses managed by the license configuration.
Boolean	licenseCountHardLimit() Sets the number of available licenses as a hard limit.
LicenseCountingType	licenseCountingType() Dimension to use to track license inventory.
String	licenseCountingTypeAsString() Dimension to use to track license inventory.
List<String>	licenseRules() Array of configured License Manager rules.
List<ManagedResourceSummary>	managedResourceSummaryList() List of summaries for managed resources.
String	name() Name of the license configuration.
String	ownerAccountId() Account ID of the license configuration's owner.
List<SdkField<?>>	sdkFields()
static Class<? extends LicenseConfiguration.Builder>	serializableBuilderClass()
String	status() Status of the license configuration.
LicenseConfiguration.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

licenseConfigurationId

public String licenseConfigurationId()

Unique ID of the LicenseConfiguration object.

Returns:

Unique ID of the LicenseConfiguration object.

licenseConfigurationArn

public String licenseConfigurationArn()

ARN of the LicenseConfiguration object.

Returns:

ARN of the LicenseConfiguration object.

name

public String name()

Name of the license configuration.

Returns:

Name of the license configuration.

description

public String description()

Description of the license configuration.

Returns:

Description of the license configuration.

licenseCountingType

public LicenseCountingType licenseCountingType()

Dimension to use to track 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 to use to track license inventory.

See Also:

LicenseCountingType

licenseCountingTypeAsString

public String licenseCountingTypeAsString()

Dimension to use to track 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 to use to track license inventory.

See Also:

LicenseCountingType

licenseRules

public List<String> licenseRules()

Array of configured License Manager rules.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Array of configured License Manager rules.

licenseCount

public Long licenseCount()

Number of licenses managed by the license configuration.

Returns:

Number of licenses managed by the license configuration.

licenseCountHardLimit

public Boolean licenseCountHardLimit()

Sets the number of available licenses as a hard limit.

Returns:

Sets the number of available licenses as a hard limit.

consumedLicenses

public Long consumedLicenses()

Number of licenses consumed.

Returns:

Number of licenses consumed.

status

public String status()

Status of the license configuration.

Returns:

Status of the license configuration.

ownerAccountId

public String ownerAccountId()

Account ID of the license configuration's owner.

Returns:

Account ID of the license configuration's owner.

consumedLicenseSummaryList

public List<ConsumedLicenseSummary> consumedLicenseSummaryList()

List of summaries for licenses consumed by various resources.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

List of summaries for licenses consumed by various resources.

managedResourceSummaryList

public List<ManagedResourceSummary> managedResourceSummaryList()

List of summaries for managed resources.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

List of summaries for managed resources.

toBuilder

public LicenseConfiguration.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<LicenseConfiguration.Builder,LicenseConfiguration>

Returns:

a builder for type T

builder

public static LicenseConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends LicenseConfiguration.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.