Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ComputeOptimizer.Types.Scope

Description

Synopsis

data Scope = Scope' {
- name :: Maybe ScopeName
- value :: Maybe Text
}
newScope :: Scope
scope_name :: Lens' Scope (Maybe ScopeName)
scope_value :: Lens' Scope (Maybe Text)

Documentation

data Scope Source #

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: newScope smart constructor.

Constructors

Scope'

Fields

name :: Maybe ScopeName
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.
value :: Maybe Text
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.

Instances

Instances details

FromJSON Scope Source #
Instance details Defined in Amazonka.ComputeOptimizer.Types.Scope Methods parseJSON :: Value -> Parser Scope # parseJSONList :: Value -> Parser [Scope] #
ToJSON Scope Source #
Instance details Defined in Amazonka.ComputeOptimizer.Types.Scope Methods toJSON :: Scope -> Value # toEncoding :: Scope -> Encoding # toJSONList :: [Scope] -> Value # toEncodingList :: [Scope] -> Encoding #
Generic Scope Source #
Instance details Defined in Amazonka.ComputeOptimizer.Types.Scope Associated Types type Rep Scope :: Type -> Type # Methods from :: Scope -> Rep Scope x # to :: Rep Scope x -> Scope #
Read Scope Source #
Instance details Defined in Amazonka.ComputeOptimizer.Types.Scope Methods readsPrec :: Int -> ReadS Scope # readList :: ReadS [Scope] # readPrec :: ReadPrec Scope # readListPrec :: ReadPrec [Scope] #
Show Scope Source #
Instance details Defined in Amazonka.ComputeOptimizer.Types.Scope Methods showsPrec :: Int -> Scope -> ShowS # show :: Scope -> String # showList :: [Scope] -> ShowS #
NFData Scope Source #
Instance details Defined in Amazonka.ComputeOptimizer.Types.Scope Methods rnf :: Scope -> () #
Eq Scope Source #
Instance details Defined in Amazonka.ComputeOptimizer.Types.Scope Methods (==) :: Scope -> Scope -> Bool # (/=) :: Scope -> Scope -> Bool #
Hashable Scope Source #
Instance details Defined in Amazonka.ComputeOptimizer.Types.Scope Methods hashWithSalt :: Int -> Scope -> Int # hash :: Scope -> Int #
type Rep Scope Source #
Instance details Defined in Amazonka.ComputeOptimizer.Types.Scope type Rep Scope = D1 ('MetaData "Scope" "Amazonka.ComputeOptimizer.Types.Scope" "amazonka-compute-optimizer-2.0-5JAMFRZoNrnJ0UCJqIgHbk" 'False) (C1 ('MetaCons "Scope'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ScopeName)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newScope :: Scope Source #

Create a value of Scope with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:Scope', scope_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.

$sel:value:Scope', scope_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.

scope_name :: Lens' Scope (Maybe ScopeName) Source #

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.

scope_value :: Lens' Scope (Maybe Text) Source #

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.