Class CfnScalableTargetProps
Properties for defining a CfnScalableTarget.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.ApplicationAutoScaling
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnScalableTargetProps : ICfnScalableTargetPropsSyntax (vb)
Public Class CfnScalableTargetProps Implements ICfnScalableTargetPropsRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ApplicationAutoScaling;
var cfnScalableTargetProps = new CfnScalableTargetProps {
MaxCapacity = 123,
MinCapacity = 123,
ResourceId = "resourceId",
ScalableDimension = "scalableDimension",
ServiceNamespace = "serviceNamespace",
// the properties below are optional
RoleArn = "roleArn",
ScheduledActions = new [] { new ScheduledActionProperty {
Schedule = "schedule",
ScheduledActionName = "scheduledActionName",
// the properties below are optional
EndTime = new Date(),
ScalableTargetAction = new ScalableTargetActionProperty {
MaxCapacity = 123,
MinCapacity = 123
},
StartTime = new Date(),
Timezone = "timezone"
} },
SuspendedState = new SuspendedStateProperty {
DynamicScalingInSuspended = false,
DynamicScalingOutSuspended = false,
ScheduledScalingSuspended = false
}
};Synopsis
Constructors
| CfnScalableTargetProps() | Properties for defining a |
Properties
| MaxCapacity | The maximum value that you plan to scale out to. |
| MinCapacity | The minimum value that you plan to scale in to. |
| ResourceId | The identifier of the resource associated with the scalable target. |
| RoleArn | Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. |
| ScalableDimension | The scalable dimension associated with the scalable target. |
| ScheduledActions | The scheduled actions for the scalable target. |
| ServiceNamespace | The namespace of the AWS service that provides the resource, or a |
| SuspendedState | An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. |
Constructors
CfnScalableTargetProps()
Properties for defining a CfnScalableTarget.
public CfnScalableTargetProps()Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ApplicationAutoScaling;
var cfnScalableTargetProps = new CfnScalableTargetProps {
MaxCapacity = 123,
MinCapacity = 123,
ResourceId = "resourceId",
ScalableDimension = "scalableDimension",
ServiceNamespace = "serviceNamespace",
// the properties below are optional
RoleArn = "roleArn",
ScheduledActions = new [] { new ScheduledActionProperty {
Schedule = "schedule",
ScheduledActionName = "scheduledActionName",
// the properties below are optional
EndTime = new Date(),
ScalableTargetAction = new ScalableTargetActionProperty {
MaxCapacity = 123,
MinCapacity = 123
},
StartTime = new Date(),
Timezone = "timezone"
} },
SuspendedState = new SuspendedStateProperty {
DynamicScalingInSuspended = false,
DynamicScalingOutSuspended = false,
ScheduledScalingSuspended = false
}
};Properties
MaxCapacity
The maximum value that you plan to scale out to.
public double MaxCapacity { get; set; }Property Value
Remarks
When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand.
MinCapacity
The minimum value that you plan to scale in to.
public double MinCapacity { get; set; }Property Value
Remarks
When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand.
ResourceId
The identifier of the resource associated with the scalable target.
public string ResourceId { get; set; }Property Value
Remarks
This string consists of the resource type and unique identifier.
RoleArn
Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf.
public string? RoleArn { get; set; }Property Value
Remarks
This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see How Application Auto Scaling works with IAM in the Application Auto Scaling User Guide .
To automatically create a service-linked role (recommended), specify the full ARN of the service-linked role in your stack template. To find the exact ARN of the service-linked role for your AWS or custom resource, see the Service-linked roles topic in the Application Auto Scaling User Guide . Look for the ARN in the table at the bottom of the page.
ScalableDimension
The scalable dimension associated with the scalable target.
public string ScalableDimension { get; set; }Property Value
Remarks
This string consists of the service namespace, resource type, and scaling property.
ScheduledActions
The scheduled actions for the scalable target.
public object? ScheduledActions { get; set; }Property Value
Remarks
ServiceNamespace
The namespace of the AWS service that provides the resource, or a custom-resource .
public string ServiceNamespace { get; set; }Property Value
Remarks
SuspendedState
An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling.
public object? SuspendedState { get; set; }Property Value
Remarks
Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities.
Suspension Outcomes