Class Options

java.lang.Object
software.amazon.awssdk.services.licensemanager.model.Options
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Options.Builder,Options>
@Generated("software.amazon.awssdk:codegen") public final class Options extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Options.Builder,Options>

The options you can specify when you create a grant or a new version of a grant, such as activation override behavior. For more information, see Granted licenses in License Manager in the License Manager User Guide.

See Also:

  • Method Details

    • activationOverrideBehavior

      public final ActivationOverrideBehavior activationOverrideBehavior()

      An activation option for your grant that determines the behavior of activating a grant. Activation options can only be used with granted licenses sourced from the Amazon Web Services Marketplace. Additionally, the operation must activate the grant. For the CreateGrantVersion operation, specify ACTIVE for the Status parameter. For the CreateGrant operation, specify ACTIVE for the DesiredStatus option.

      • As a license administrator, you can optionally specify an ActivationOverrideBehavior when activating a grant.

      • As a grantor, you can optionally specify an ActivationOverrideBehavior when you activate a grant for a grantee account in your organization.

      • As a grantee, if the grantor creating the distributed grant doesn’t specify an ActivationOverrideBehavior, you can optionally specify one when you are activating the grant.

      DISTRIBUTED_GRANTS_ONLY

      Use this value to activate a grant without replacing any member account’s active grants for the same product.

      ALL_GRANTS_PERMITTED_BY_ISSUER

      Use this value to activate a grant and disable other active grants in any member accounts for the same product. This action will also replace their previously activated grants with this activated grant.

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

      Returns:
      An activation option for your grant that determines the behavior of activating a grant. Activation options can only be used with granted licenses sourced from the Amazon Web Services Marketplace. Additionally, the operation must activate the grant. For the CreateGrantVersion operation, specify ACTIVE for the Status parameter. For the CreateGrant operation, specify ACTIVE for the DesiredStatus option.

      • As a license administrator, you can optionally specify an ActivationOverrideBehavior when activating a grant.

      • As a grantor, you can optionally specify an ActivationOverrideBehavior when you activate a grant for a grantee account in your organization.

      • As a grantee, if the grantor creating the distributed grant doesn’t specify an ActivationOverrideBehavior, you can optionally specify one when you are activating the grant.

      DISTRIBUTED_GRANTS_ONLY

      Use this value to activate a grant without replacing any member account’s active grants for the same product.

      ALL_GRANTS_PERMITTED_BY_ISSUER

      Use this value to activate a grant and disable other active grants in any member accounts for the same product. This action will also replace their previously activated grants with this activated grant.

      See Also:

    • activationOverrideBehaviorAsString

      public final String activationOverrideBehaviorAsString()

      An activation option for your grant that determines the behavior of activating a grant. Activation options can only be used with granted licenses sourced from the Amazon Web Services Marketplace. Additionally, the operation must activate the grant. For the CreateGrantVersion operation, specify ACTIVE for the Status parameter. For the CreateGrant operation, specify ACTIVE for the DesiredStatus option.

      • As a license administrator, you can optionally specify an ActivationOverrideBehavior when activating a grant.

      • As a grantor, you can optionally specify an ActivationOverrideBehavior when you activate a grant for a grantee account in your organization.

      • As a grantee, if the grantor creating the distributed grant doesn’t specify an ActivationOverrideBehavior, you can optionally specify one when you are activating the grant.

      DISTRIBUTED_GRANTS_ONLY

      Use this value to activate a grant without replacing any member account’s active grants for the same product.

      ALL_GRANTS_PERMITTED_BY_ISSUER

      Use this value to activate a grant and disable other active grants in any member accounts for the same product. This action will also replace their previously activated grants with this activated grant.

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

      Returns:
      An activation option for your grant that determines the behavior of activating a grant. Activation options can only be used with granted licenses sourced from the Amazon Web Services Marketplace. Additionally, the operation must activate the grant. For the CreateGrantVersion operation, specify ACTIVE for the Status parameter. For the CreateGrant operation, specify ACTIVE for the DesiredStatus option.

      • As a license administrator, you can optionally specify an ActivationOverrideBehavior when activating a grant.

      • As a grantor, you can optionally specify an ActivationOverrideBehavior when you activate a grant for a grantee account in your organization.

      • As a grantee, if the grantor creating the distributed grant doesn’t specify an ActivationOverrideBehavior, you can optionally specify one when you are activating the grant.

      DISTRIBUTED_GRANTS_ONLY

      Use this value to activate a grant without replacing any member account’s active grants for the same product.

      ALL_GRANTS_PERMITTED_BY_ISSUER

      Use this value to activate a grant and disable other active grants in any member accounts for the same product. This action will also replace their previously activated grants with this activated grant.

      See Also:

    • desiredStatus

      public final GrantStatus desiredStatus()

      The status of the grant after License Manager creates it. The only supported value is ACTIVE. Specify ACTIVE to create and activate the grant in one request.

      You can specify this option only for the CreateGrant operation, and only when the grant principal is an organization or an organizational unit (OU). To change the status of an existing grant, use the Status parameter of the CreateGrantVersion operation.

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

      Returns:
      The status of the grant after License Manager creates it. The only supported value is ACTIVE . Specify ACTIVE to create and activate the grant in one request.

      You can specify this option only for the CreateGrant operation, and only when the grant principal is an organization or an organizational unit (OU). To change the status of an existing grant, use the Status parameter of the CreateGrantVersion operation.

      See Also:

    • desiredStatusAsString

      public final String desiredStatusAsString()

      The status of the grant after License Manager creates it. The only supported value is ACTIVE. Specify ACTIVE to create and activate the grant in one request.

      You can specify this option only for the CreateGrant operation, and only when the grant principal is an organization or an organizational unit (OU). To change the status of an existing grant, use the Status parameter of the CreateGrantVersion operation.

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

      Returns:
      The status of the grant after License Manager creates it. The only supported value is ACTIVE . Specify ACTIVE to create and activate the grant in one request.

      You can specify this option only for the CreateGrant operation, and only when the grant principal is an organization or an organizational unit (OU). To change the status of an existing grant, use the Status parameter of the CreateGrantVersion operation.

      See Also:

    • toBuilder

      public Options.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<Options.Builder,Options>
      Returns:
      a builder for type T

    • builder

      public static Options.Builder builder()

    • serializableBuilderClass

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