Docs
PackagesAWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
aws-native.applicationautoscaling.ScalableTarget
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
Resource Type definition for AWS::ApplicationAutoScaling::ScalableTarget
Create ScalableTarget Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ScalableTarget(name: string, args: ScalableTargetArgs, opts?: CustomResourceOptions);@overload
def ScalableTarget(resource_name: str,
args: ScalableTargetArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ScalableTarget(resource_name: str,
opts: Optional[ResourceOptions] = None,
max_capacity: Optional[int] = None,
min_capacity: Optional[int] = None,
resource_id: Optional[str] = None,
scalable_dimension: Optional[str] = None,
service_namespace: Optional[str] = None,
role_arn: Optional[str] = None,
scheduled_actions: Optional[Sequence[ScalableTargetScheduledActionArgs]] = None,
suspended_state: Optional[ScalableTargetSuspendedStateArgs] = None)func NewScalableTarget(ctx *Context, name string, args ScalableTargetArgs, opts ...ResourceOption) (*ScalableTarget, error)public ScalableTarget(string name, ScalableTargetArgs args, CustomResourceOptions? opts = null)
public ScalableTarget(String name, ScalableTargetArgs args)
public ScalableTarget(String name, ScalableTargetArgs args, CustomResourceOptions options)
type: aws-native:applicationautoscaling:ScalableTarget
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ScalableTargetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ScalableTargetArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ScalableTargetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ScalableTargetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ScalableTargetArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const scalableTargetResource = new aws_native.applicationautoscaling.ScalableTarget("scalableTargetResource", {
maxCapacity: 0,
minCapacity: 0,
resourceId: "string",
scalableDimension: "string",
serviceNamespace: "string",
roleArn: "string",
scheduledActions: [{
schedule: "string",
scheduledActionName: "string",
endTime: "string",
scalableTargetAction: {
maxCapacity: 0,
minCapacity: 0,
},
startTime: "string",
timezone: "string",
}],
suspendedState: {
dynamicScalingInSuspended: false,
dynamicScalingOutSuspended: false,
scheduledScalingSuspended: false,
},
});
Coming soon!
ScalableTarget Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The ScalableTarget resource accepts the following input properties:
- Max
Capacity int - The maximum value that you plan to scale in to. 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
- Min
Capacity int - The minimum value that you plan to scale in to. 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
- Resource
Id string - The identifier of the resource associated with the scalable target
- Scalable
Dimension string - The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property
- Service
Namespace string - The namespace of the AWS service that provides the resource, or a custom-resource
- Role
Arn string - 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.
- Scheduled
Actions List<Pulumi.Aws Native. Application Auto Scaling. Inputs. Scalable Target Scheduled Action> - The scheduled actions for the scalable target. Duplicates aren't allowed.
- Suspended
State Pulumi.Aws Native. Application Auto Scaling. Inputs. Scalable Target Suspended State - An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities.
- Max
Capacity int - The maximum value that you plan to scale in to. 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
- Min
Capacity int - The minimum value that you plan to scale in to. 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
- Resource
Id string - The identifier of the resource associated with the scalable target
- Scalable
Dimension string - The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property
- Service
Namespace string - The namespace of the AWS service that provides the resource, or a custom-resource
- Role
Arn string - 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.
- Scheduled
Actions []ScalableTarget Scheduled Action Args - The scheduled actions for the scalable target. Duplicates aren't allowed.
- Suspended
State ScalableTarget Suspended State Args - An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities.
- max
Capacity Integer - The maximum value that you plan to scale in to. 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
- min
Capacity Integer - The minimum value that you plan to scale in to. 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
- resource
Id String - The identifier of the resource associated with the scalable target
- scalable
Dimension String - The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property
- service
Namespace String - The namespace of the AWS service that provides the resource, or a custom-resource
- role
Arn String - 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.
- scheduled
Actions List<ScalableTarget Scheduled Action> - The scheduled actions for the scalable target. Duplicates aren't allowed.
- suspended
State ScalableTarget Suspended State - An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities.
- max
Capacity number - The maximum value that you plan to scale in to. 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
- min
Capacity number - The minimum value that you plan to scale in to. 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
- resource
Id string - The identifier of the resource associated with the scalable target
- scalable
Dimension string - The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property
- service
Namespace string - The namespace of the AWS service that provides the resource, or a custom-resource
- role
Arn string - 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.
- scheduled
Actions ScalableTarget Scheduled Action[] - The scheduled actions for the scalable target. Duplicates aren't allowed.
- suspended
State ScalableTarget Suspended State - An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities.
- max_
capacity int - The maximum value that you plan to scale in to. 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
- min_
capacity int - The minimum value that you plan to scale in to. 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
- resource_
id str - The identifier of the resource associated with the scalable target
- scalable_
dimension str - The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property
- service_
namespace str - The namespace of the AWS service that provides the resource, or a custom-resource
- role_
arn str - 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.
- scheduled_
actions Sequence[ScalableTarget Scheduled Action Args] - The scheduled actions for the scalable target. Duplicates aren't allowed.
- suspended_
state ScalableTarget Suspended State Args - An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities.
- max
Capacity Number - The maximum value that you plan to scale in to. 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
- min
Capacity Number - The minimum value that you plan to scale in to. 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
- resource
Id String - The identifier of the resource associated with the scalable target
- scalable
Dimension String - The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property
- service
Namespace String - The namespace of the AWS service that provides the resource, or a custom-resource
- role
Arn String - 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.
- scheduled
Actions List<Property Map> - The scheduled actions for the scalable target. Duplicates aren't allowed.
- suspended
State Property Map - An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities.
Outputs
All input properties are implicitly available as output properties. Additionally, the ScalableTarget resource produces the following output properties:
Supporting Types
ScalableTargetAction, ScalableTargetActionArgs
- Max
Capacity int - Min
Capacity int
- Max
Capacity int - Min
Capacity int
- max
Capacity Integer - min
Capacity Integer
- max
Capacity number - min
Capacity number
- max_
capacity int - min_
capacity int
- max
Capacity Number - min
Capacity Number
ScalableTargetScheduledAction, ScalableTargetScheduledActionArgs
- Schedule string
- Scheduled
Action stringName - End
Time string - Scalable
Target Pulumi.Action Aws Native. Application Auto Scaling. Inputs. Scalable Target Action - Start
Time string - Timezone string
- Schedule string
- Scheduled
Action stringName - End
Time string - Scalable
Target ScalableAction Target Action - Start
Time string - Timezone string
- schedule String
- scheduled
Action StringName - end
Time String - scalable
Target ScalableAction Target Action - start
Time String - timezone String
- schedule string
- scheduled
Action stringName - end
Time string - scalable
Target ScalableAction Target Action - start
Time string - timezone string
- schedule String
- scheduled
Action StringName - end
Time String - scalable
Target Property MapAction - start
Time String - timezone String
ScalableTargetSuspendedState, ScalableTargetSuspendedStateArgs
- dynamic
Scaling BooleanIn Suspended - dynamic
Scaling BooleanOut Suspended - scheduled
Scaling BooleanSuspended
- dynamic
Scaling booleanIn Suspended - dynamic
Scaling booleanOut Suspended - scheduled
Scaling booleanSuspended
- dynamic
Scaling BooleanIn Suspended - dynamic
Scaling BooleanOut Suspended - scheduled
Scaling BooleanSuspended
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi