@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Scope extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
Scope() |
Modifier and Type | Method and Description |
---|---|
Scope |
clone() |
boolean |
equals(Object obj) |
String |
getName()
The name of the scope.
|
String |
getValue()
The value of the scope.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setName(String name)
The name of the scope.
|
void |
setValue(String value)
The value of the scope.
|
String |
toString()
Returns a string representation of this object.
|
Scope |
withName(ScopeName name)
The name of the scope.
|
Scope |
withName(String name)
The name of the scope.
|
Scope |
withValue(String value)
The value of the scope.
|
public void setName(String 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.
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.
ScopeName
public String getName()
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.
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.
ScopeName
public Scope withName(String 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.
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.
ScopeName
public Scope withName(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.
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.
ScopeName
public void setValue(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.
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.
public String getValue()
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.
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.
public Scope withValue(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.
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.
public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.