Class Scope
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Scope.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final ScopeName
name()
The name of the scope.final String
The name of the scope.static Class
<? extends Scope.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
value()
The value of the scope.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnScopeName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- 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
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 returnScopeName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- 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
The value of the scope.
If you specified the
name
of the scope as:-
Organization
- Thevalue
must beALL_ACCOUNTS
. -
AccountId
- Thevalue
must be a 12-digit Amazon Web Services account ID. -
ResourceArn
- Thevalue
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
- Thevalue
must beALL_ACCOUNTS
. -
AccountId
- Thevalue
must be a 12-digit Amazon Web Services account ID. -
ResourceArn
- Thevalue
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
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 interfaceToCopyableBuilder<Scope.Builder,
Scope> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-