Class LicenseConfiguration

java.lang.Object
software.amazon.awssdk.services.licensemanager.model.LicenseConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LicenseConfiguration.Builder,LicenseConfiguration>
@Generated("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), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), host affinity (how long a VM must be associated with a host), and the number of licenses purchased and used.

See Also:

  • Method Details

    • licenseConfigurationId

      public final String licenseConfigurationId()

      Unique ID of the license configuration.

      Returns:
      Unique ID of the license configuration.

    • licenseConfigurationArn

      public final String licenseConfigurationArn()

      Amazon Resource Name (ARN) of the license configuration.

      Returns:
      Amazon Resource Name (ARN) of the license configuration.

    • 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 to use 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 to use to track the license inventory.
      See Also:

    • licenseCountingTypeAsString

      public final String licenseCountingTypeAsString()

      Dimension to use 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 to use to track the license inventory.
      See Also:

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

      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.

    • 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()

      Number of available licenses as a hard limit.

      Returns:
      Number of available licenses as a hard limit.

    • disassociateWhenNotFound

      public final Boolean disassociateWhenNotFound()

      When true, disassociates a resource when software is uninstalled.

      Returns:
      When true, disassociates a resource when software is uninstalled.

    • consumedLicenses

      public final Long consumedLicenses()

      Number of licenses consumed.

      Returns:
      Number of licenses consumed.

    • status

      public final String status()

      Status of the license configuration.

      Returns:
      Status of the license configuration.

    • ownerAccountId

      public final String ownerAccountId()

      Account ID of the license configuration's owner.

      Returns:
      Account ID of the license configuration's owner.

    • hasConsumedLicenseSummaryList

      public final boolean hasConsumedLicenseSummaryList()
      For responses, this returns true if the service returned a value for the ConsumedLicenseSummaryList 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.

    • consumedLicenseSummaryList

      public final List<ConsumedLicenseSummary> consumedLicenseSummaryList()

      Summaries for licenses consumed by various resources.

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

      Returns:
      Summaries for licenses consumed by various resources.

    • hasManagedResourceSummaryList

      public final boolean hasManagedResourceSummaryList()
      For responses, this returns true if the service returned a value for the ManagedResourceSummaryList 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.

    • managedResourceSummaryList

      public final List<ManagedResourceSummary> managedResourceSummaryList()

      Summaries for managed resources.

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

      Returns:
      Summaries for managed resources.

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

    • automatedDiscoveryInformation

      public final AutomatedDiscoveryInformation automatedDiscoveryInformation()

      Automated discovery information.

      Returns:
      Automated discovery information.

    • 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 final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.