Class Scope

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

Describes the scope of a recommendation preference.

Recommendation preferences can be created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

You cannot create recommendation preferences for Auto Scaling groups at the organization and account levels. You can create recommendation preferences for Auto Scaling groups only at the resource level by specifying a scope name of ResourceArn and a scope value of the Auto Scaling group Amazon Resource Name (ARN). This will configure the preference for all instances that are part of the specified Auto Scaling group. You also cannot create recommendation preferences at the resource level for instances that are part of an Auto Scaling group. You can create recommendation preferences at the resource level only for standalone instances.

See Also:

  • Method Details

    • name

      public final ScopeName name()

      The name of the scope.

      The following scopes are possible:

      • Organization - Specifies that the recommendation preference applies at the organization level, for all member accounts of an organization.

      • AccountId - Specifies that the recommendation preference applies at the account level, for all resources of a given resource type in an account.

      • ResourceArn - Specifies that the recommendation preference applies at the individual resource level.

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

      Returns:
      The name of the scope.

      The following scopes are possible:

      • Organization - Specifies that the recommendation preference applies at the organization level, for all member accounts of an organization.

      • AccountId - Specifies that the recommendation preference applies at the account level, for all resources of a given resource type in an account.

      • ResourceArn - Specifies that the recommendation preference applies at the individual resource level.

      See Also:

    • nameAsString

      public final String nameAsString()

      The name of the scope.

      The following scopes are possible:

      • Organization - Specifies that the recommendation preference applies at the organization level, for all member accounts of an organization.

      • AccountId - Specifies that the recommendation preference applies at the account level, for all resources of a given resource type in an account.

      • ResourceArn - Specifies that the recommendation preference applies at the individual resource level.

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

      Returns:
      The name of the scope.

      The following scopes are possible:

      • Organization - Specifies that the recommendation preference applies at the organization level, for all member accounts of an organization.

      • AccountId - Specifies that the recommendation preference applies at the account level, for all resources of a given resource type in an account.

      • ResourceArn - Specifies that the recommendation preference applies at the individual resource level.

      See Also:

    • value

      public final String value()

      The value of the scope.

      If you specified the name of the scope as:

      • Organization - The value must be ALL_ACCOUNTS.

      • AccountId - The value must be a 12-digit Amazon Web Services account ID.

      • ResourceArn - The value must be the Amazon Resource Name (ARN) of an EC2 instance or an Auto Scaling group.

      Only EC2 instance and Auto Scaling group ARNs are currently supported.

      Returns:
      The value of the scope.

      If you specified the name of the scope as:

      • Organization - The value must be ALL_ACCOUNTS.

      • AccountId - The value must be a 12-digit Amazon Web Services account ID.

      • ResourceArn - The value must be the Amazon Resource Name (ARN) of an EC2 instance or an Auto Scaling group.

      Only EC2 instance and Auto Scaling group ARNs are currently supported.

    • toBuilder

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

    • builder

      public static Scope.Builder builder()

    • serializableBuilderClass

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