Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.AutoScalingPlans.Types.ScalingPlanResource

Description

Synopsis

Documentation

data ScalingPlanResource Source #

Represents a scalable resource.

See: newScalingPlanResource smart constructor.

Constructors

ScalingPlanResource'

Fields

scalingStatusMessage :: Maybe Text
A simple message about the current scaling status of the resource.
scalingPolicies :: Maybe [ScalingPolicy]
The scaling policies.
scalingPlanName :: Text
The name of the scaling plan.
scalingPlanVersion :: Integer
The version number of the scaling plan.
serviceNamespace :: ServiceNamespace
The namespace of the AWS service.
resourceId :: Text
The ID of the resource. This string consists of the resource type and unique identifier.
- Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.
- ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
- Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
- DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.
- DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.
- Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
scalableDimension :: ScalableDimension
The scalable dimension for the resource.
- autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.
- ecs:service:DesiredCount - The desired task count of an ECS service.
- ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
- dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
- dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
- dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
- dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
- rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
scalingStatusCode :: ScalingStatusCode
The scaling status of the resource.
- Active - The scaling configuration is active.
- Inactive - The scaling configuration is not active because the scaling plan is being created or the scaling configuration could not be applied. Check the status message for more information.
- PartiallyActive - The scaling configuration is partially active because the scaling plan is being created or deleted or the scaling configuration could not be fully applied. Check the status message for more information.

Instances

Instances details

Eq ScalingPlanResource Source #
Instance details Defined in Amazonka.AutoScalingPlans.Types.ScalingPlanResource Methods (==) :: ScalingPlanResource -> ScalingPlanResource -> Bool # (/=) :: ScalingPlanResource -> ScalingPlanResource -> Bool #
Read ScalingPlanResource Source #
Instance details Defined in Amazonka.AutoScalingPlans.Types.ScalingPlanResource Methods readsPrec :: Int -> ReadS ScalingPlanResource # readList :: ReadS [ScalingPlanResource] # readPrec :: ReadPrec ScalingPlanResource # readListPrec :: ReadPrec [ScalingPlanResource] #
Show ScalingPlanResource Source #
Instance details Defined in Amazonka.AutoScalingPlans.Types.ScalingPlanResource Methods showsPrec :: Int -> ScalingPlanResource -> ShowS # show :: ScalingPlanResource -> String # showList :: [ScalingPlanResource] -> ShowS #
Generic ScalingPlanResource Source #
Instance details Defined in Amazonka.AutoScalingPlans.Types.ScalingPlanResource Associated Types type Rep ScalingPlanResource :: Type -> Type # Methods from :: ScalingPlanResource -> Rep ScalingPlanResource x # to :: Rep ScalingPlanResource x -> ScalingPlanResource #
NFData ScalingPlanResource Source #
Instance details Defined in Amazonka.AutoScalingPlans.Types.ScalingPlanResource Methods rnf :: ScalingPlanResource -> () #
Hashable ScalingPlanResource Source #
Instance details Defined in Amazonka.AutoScalingPlans.Types.ScalingPlanResource Methods hashWithSalt :: Int -> ScalingPlanResource -> Int # hash :: ScalingPlanResource -> Int #
FromJSON ScalingPlanResource Source #
Instance details Defined in Amazonka.AutoScalingPlans.Types.ScalingPlanResource Methods parseJSON :: Value -> Parser ScalingPlanResource # parseJSONList :: Value -> Parser [ScalingPlanResource] #
type Rep ScalingPlanResource Source #
Instance details Defined in Amazonka.AutoScalingPlans.Types.ScalingPlanResource type Rep ScalingPlanResource = D1 ('MetaData "ScalingPlanResource" "Amazonka.AutoScalingPlans.Types.ScalingPlanResource" "libZSservicesZSamazonka-autoscaling-plansZSamazonka-autoscaling-plans" 'False) (C1 ('MetaCons "ScalingPlanResource'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "scalingStatusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "scalingPolicies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ScalingPolicy]))) :: (S1 ('MetaSel ('Just "scalingPlanName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "scalingPlanVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer))) :: ((S1 ('MetaSel ('Just "serviceNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ServiceNamespace) :: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "scalableDimension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ScalableDimension) :*: S1 ('MetaSel ('Just "scalingStatusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ScalingStatusCode)))))

newScalingPlanResource Source #

Arguments

:: Text	`$sel:scalingPlanName:ScalingPlanResource'`
-> Integer	`$sel:scalingPlanVersion:ScalingPlanResource'`
-> ServiceNamespace	`$sel:serviceNamespace:ScalingPlanResource'`
-> Text	`$sel:resourceId:ScalingPlanResource'`
-> ScalableDimension	`$sel:scalableDimension:ScalingPlanResource'`
-> ScalingStatusCode	`$sel:scalingStatusCode:ScalingPlanResource'`
-> ScalingPlanResource

Create a value of ScalingPlanResource 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:scalingStatusMessage:ScalingPlanResource', scalingPlanResource_scalingStatusMessage - A simple message about the current scaling status of the resource.

$sel:scalingPolicies:ScalingPlanResource', scalingPlanResource_scalingPolicies - The scaling policies.

$sel:scalingPlanName:ScalingPlanResource', scalingPlanResource_scalingPlanName - The name of the scaling plan.

$sel:scalingPlanVersion:ScalingPlanResource', scalingPlanResource_scalingPlanVersion - The version number of the scaling plan.

$sel:serviceNamespace:ScalingPlanResource', scalingPlanResource_serviceNamespace - The namespace of the AWS service.

$sel:resourceId:ScalingPlanResource', scalingPlanResource_resourceId - The ID of the resource. This string consists of the resource type and unique identifier.

Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

$sel:scalableDimension:ScalingPlanResource', scalingPlanResource_scalableDimension - The scalable dimension for the resource.

autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

$sel:scalingStatusCode:ScalingPlanResource', scalingPlanResource_scalingStatusCode - The scaling status of the resource.

Active - The scaling configuration is active.
Inactive - The scaling configuration is not active because the scaling plan is being created or the scaling configuration could not be applied. Check the status message for more information.
PartiallyActive - The scaling configuration is partially active because the scaling plan is being created or deleted or the scaling configuration could not be fully applied. Check the status message for more information.

scalingPlanResource_scalingStatusMessage :: Lens' ScalingPlanResource (Maybe Text) Source #

A simple message about the current scaling status of the resource.

scalingPlanResource_scalingPolicies :: Lens' ScalingPlanResource (Maybe [ScalingPolicy]) Source #

The scaling policies.

scalingPlanResource_scalingPlanName :: Lens' ScalingPlanResource Text Source #

The name of the scaling plan.

scalingPlanResource_scalingPlanVersion :: Lens' ScalingPlanResource Integer Source #

The version number of the scaling plan.

scalingPlanResource_serviceNamespace :: Lens' ScalingPlanResource ServiceNamespace Source #

The namespace of the AWS service.

scalingPlanResource_resourceId :: Lens' ScalingPlanResource Text Source #

The ID of the resource. This string consists of the resource type and unique identifier.

Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

scalingPlanResource_scalableDimension :: Lens' ScalingPlanResource ScalableDimension Source #

The scalable dimension for the resource.

autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.
ecs:service:DesiredCount - The desired task count of an ECS service.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

scalingPlanResource_scalingStatusCode :: Lens' ScalingPlanResource ScalingStatusCode Source #

The scaling status of the resource.

Active - The scaling configuration is active.
Inactive - The scaling configuration is not active because the scaling plan is being created or the scaling configuration could not be applied. Check the status message for more information.
PartiallyActive - The scaling configuration is partially active because the scaling plan is being created or deleted or the scaling configuration could not be fully applied. Check the status message for more information.