Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. applicationautoscaling
  5. getScalableTarget

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.applicationautoscaling.getScalableTarget

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::ApplicationAutoScaling::ScalableTarget

    Using getScalableTarget

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getScalableTarget(args: GetScalableTargetArgs, opts?: InvokeOptions): Promise<GetScalableTargetResult>
function getScalableTargetOutput(args: GetScalableTargetOutputArgs, opts?: InvokeOptions): Output<GetScalableTargetResult>
    def get_scalable_target(resource_id: Optional[str] = None,
                        scalable_dimension: Optional[str] = None,
                        service_namespace: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetScalableTargetResult
def get_scalable_target_output(resource_id: Optional[pulumi.Input[str]] = None,
                        scalable_dimension: Optional[pulumi.Input[str]] = None,
                        service_namespace: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetScalableTargetResult]
    func LookupScalableTarget(ctx *Context, args *LookupScalableTargetArgs, opts ...InvokeOption) (*LookupScalableTargetResult, error)
func LookupScalableTargetOutput(ctx *Context, args *LookupScalableTargetOutputArgs, opts ...InvokeOption) LookupScalableTargetResultOutput

    > Note: This function is named LookupScalableTarget in the Go SDK.

    public static class GetScalableTarget 
{
    public static Task<GetScalableTargetResult> InvokeAsync(GetScalableTargetArgs args, InvokeOptions? opts = null)
    public static Output<GetScalableTargetResult> Invoke(GetScalableTargetInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetScalableTargetResult> getScalableTarget(GetScalableTargetArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:applicationautoscaling:getScalableTarget
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceId string
    The identifier of the resource associated with the scalable target
    ScalableDimension string
    The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property
    ServiceNamespace string
    The namespace of the AWS service that provides the resource, or a custom-resource
    ResourceId string
    The identifier of the resource associated with the scalable target
    ScalableDimension string
    The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property
    ServiceNamespace string
    The namespace of the AWS service that provides the resource, or a custom-resource
    resourceId String
    The identifier of the resource associated with the scalable target
    scalableDimension String
    The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property
    serviceNamespace String
    The namespace of the AWS service that provides the resource, or a custom-resource
    resourceId string
    The identifier of the resource associated with the scalable target
    scalableDimension string
    The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property
    serviceNamespace string
    The namespace of the AWS service that provides the resource, or a custom-resource
    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
    resourceId String
    The identifier of the resource associated with the scalable target
    scalableDimension String
    The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property
    serviceNamespace String
    The namespace of the AWS service that provides the resource, or a custom-resource

    getScalableTarget Result

    The following output properties are available:

    Id string
    This value can be returned by using the Ref function. Ref returns the Cloudformation generated ID of the resource in format - ResourceId|ScalableDimension|ServiceNamespace
    MaxCapacity 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
    MinCapacity 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
    ScheduledActions List<Pulumi.AwsNative.ApplicationAutoScaling.Outputs.ScalableTargetScheduledAction>
    The scheduled actions for the scalable target. Duplicates aren't allowed.
    SuspendedState Pulumi.AwsNative.ApplicationAutoScaling.Outputs.ScalableTargetSuspendedState
    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.
    Id string
    This value can be returned by using the Ref function. Ref returns the Cloudformation generated ID of the resource in format - ResourceId|ScalableDimension|ServiceNamespace
    MaxCapacity 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
    MinCapacity 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
    ScheduledActions []ScalableTargetScheduledAction
    The scheduled actions for the scalable target. Duplicates aren't allowed.
    SuspendedState ScalableTargetSuspendedState
    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.
    id String
    This value can be returned by using the Ref function. Ref returns the Cloudformation generated ID of the resource in format - ResourceId|ScalableDimension|ServiceNamespace
    maxCapacity 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
    minCapacity 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
    scheduledActions List<ScalableTargetScheduledAction>
    The scheduled actions for the scalable target. Duplicates aren't allowed.
    suspendedState ScalableTargetSuspendedState
    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.
    id string
    This value can be returned by using the Ref function. Ref returns the Cloudformation generated ID of the resource in format - ResourceId|ScalableDimension|ServiceNamespace
    maxCapacity 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
    minCapacity 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
    scheduledActions ScalableTargetScheduledAction[]
    The scheduled actions for the scalable target. Duplicates aren't allowed.
    suspendedState ScalableTargetSuspendedState
    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.
    id str
    This value can be returned by using the Ref function. Ref returns the Cloudformation generated ID of the resource in format - ResourceId|ScalableDimension|ServiceNamespace
    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
    scheduled_actions Sequence[ScalableTargetScheduledAction]
    The scheduled actions for the scalable target. Duplicates aren't allowed.
    suspended_state ScalableTargetSuspendedState
    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.
    id String
    This value can be returned by using the Ref function. Ref returns the Cloudformation generated ID of the resource in format - ResourceId|ScalableDimension|ServiceNamespace
    maxCapacity 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
    minCapacity 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
    scheduledActions List<Property Map>
    The scheduled actions for the scalable target. Duplicates aren't allowed.
    suspendedState 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.

    Supporting Types

    ScalableTargetAction

    maxCapacity Integer
    minCapacity Integer

    ScalableTargetScheduledAction

    ScalableTargetSuspendedState

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-aws-native