1. Packages
  2. Aptible Provider
  3. API Docs
  4. App
aptible 0.9.12 published on Monday, Apr 14, 2025 by aptible

aptible.App

Explore with Pulumi AI

aptible logo
aptible 0.9.12 published on Monday, Apr 14, 2025 by aptible

    Import

    Existing Apps can be imported using the App ID. For example:

    bash

    $ pulumi import aptible:index/app:App example-app <ID>
    

    Create App Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new App(name: string, args: AppArgs, opts?: CustomResourceOptions);
    @overload
    def App(resource_name: str,
            args: AppArgs,
            opts: Optional[ResourceOptions] = None)
    
    @overload
    def App(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            env_id: Optional[float] = None,
            handle: Optional[str] = None,
            aptible_app_id: Optional[str] = None,
            config: Optional[Mapping[str, str]] = None,
            services: Optional[Sequence[AppServiceArgs]] = None)
    func NewApp(ctx *Context, name string, args AppArgs, opts ...ResourceOption) (*App, error)
    public App(string name, AppArgs args, CustomResourceOptions? opts = null)
    public App(String name, AppArgs args)
    public App(String name, AppArgs args, CustomResourceOptions options)
    
    type: aptible:App
    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 AppArgs
    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 AppArgs
    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 AppArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var appResource = new Aptible.App("appResource", new()
    {
        EnvId = 0,
        Handle = "string",
        AptibleAppId = "string",
        Config = 
        {
            { "string", "string" },
        },
        Services = new[]
        {
            new Aptible.Inputs.AppServiceArgs
            {
                AutoscalingPolicies = new[]
                {
                    new Aptible.Inputs.AppServiceAutoscalingPolicyArgs
                    {
                        AutoscalingType = "string",
                        MaxContainers = 0,
                        MaxCpuThreshold = 0,
                        MaximumMemory = 0,
                        MemCpuRatioCThreshold = 0,
                        MemCpuRatioRThreshold = 0,
                        MemScaleDownThreshold = 0,
                        MemScaleUpThreshold = 0,
                        MetricLookbackSeconds = 0,
                        MinContainers = 0,
                        MinCpuThreshold = 0,
                        MinimumMemory = 0,
                        Percentile = 0,
                        PostReleaseCooldownSeconds = 0,
                        PostScaleDownCooldownSeconds = 0,
                        PostScaleUpCooldownSeconds = 0,
                        ScaleDownStep = 0,
                        ScaleUpStep = 0,
                        ScalingEnabled = false,
                    },
                },
                ContainerCount = 0,
                ContainerMemoryLimit = 0,
                ContainerProfile = "string",
                ForceZeroDowntime = false,
                ProcessType = "string",
                SimpleHealthCheck = false,
            },
        },
    });
    
    example, err := aptible.NewApp(ctx, "appResource", &aptible.AppArgs{
    	EnvId:        pulumi.Float64(0),
    	Handle:       pulumi.String("string"),
    	AptibleAppId: pulumi.String("string"),
    	Config: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Services: aptible.AppServiceArray{
    		&aptible.AppServiceArgs{
    			AutoscalingPolicies: aptible.AppServiceAutoscalingPolicyArray{
    				&aptible.AppServiceAutoscalingPolicyArgs{
    					AutoscalingType:              pulumi.String("string"),
    					MaxContainers:                pulumi.Float64(0),
    					MaxCpuThreshold:              pulumi.Float64(0),
    					MaximumMemory:                pulumi.Float64(0),
    					MemCpuRatioCThreshold:        pulumi.Float64(0),
    					MemCpuRatioRThreshold:        pulumi.Float64(0),
    					MemScaleDownThreshold:        pulumi.Float64(0),
    					MemScaleUpThreshold:          pulumi.Float64(0),
    					MetricLookbackSeconds:        pulumi.Float64(0),
    					MinContainers:                pulumi.Float64(0),
    					MinCpuThreshold:              pulumi.Float64(0),
    					MinimumMemory:                pulumi.Float64(0),
    					Percentile:                   pulumi.Float64(0),
    					PostReleaseCooldownSeconds:   pulumi.Float64(0),
    					PostScaleDownCooldownSeconds: pulumi.Float64(0),
    					PostScaleUpCooldownSeconds:   pulumi.Float64(0),
    					ScaleDownStep:                pulumi.Float64(0),
    					ScaleUpStep:                  pulumi.Float64(0),
    					ScalingEnabled:               pulumi.Bool(false),
    				},
    			},
    			ContainerCount:       pulumi.Float64(0),
    			ContainerMemoryLimit: pulumi.Float64(0),
    			ContainerProfile:     pulumi.String("string"),
    			ForceZeroDowntime:    pulumi.Bool(false),
    			ProcessType:          pulumi.String("string"),
    			SimpleHealthCheck:    pulumi.Bool(false),
    		},
    	},
    })
    
    var appResource = new App("appResource", AppArgs.builder()
        .envId(0)
        .handle("string")
        .aptibleAppId("string")
        .config(Map.of("string", "string"))
        .services(AppServiceArgs.builder()
            .autoscalingPolicies(AppServiceAutoscalingPolicyArgs.builder()
                .autoscalingType("string")
                .maxContainers(0)
                .maxCpuThreshold(0)
                .maximumMemory(0)
                .memCpuRatioCThreshold(0)
                .memCpuRatioRThreshold(0)
                .memScaleDownThreshold(0)
                .memScaleUpThreshold(0)
                .metricLookbackSeconds(0)
                .minContainers(0)
                .minCpuThreshold(0)
                .minimumMemory(0)
                .percentile(0)
                .postReleaseCooldownSeconds(0)
                .postScaleDownCooldownSeconds(0)
                .postScaleUpCooldownSeconds(0)
                .scaleDownStep(0)
                .scaleUpStep(0)
                .scalingEnabled(false)
                .build())
            .containerCount(0)
            .containerMemoryLimit(0)
            .containerProfile("string")
            .forceZeroDowntime(false)
            .processType("string")
            .simpleHealthCheck(false)
            .build())
        .build());
    
    app_resource = aptible.App("appResource",
        env_id=0,
        handle="string",
        aptible_app_id="string",
        config={
            "string": "string",
        },
        services=[{
            "autoscaling_policies": [{
                "autoscaling_type": "string",
                "max_containers": 0,
                "max_cpu_threshold": 0,
                "maximum_memory": 0,
                "mem_cpu_ratio_c_threshold": 0,
                "mem_cpu_ratio_r_threshold": 0,
                "mem_scale_down_threshold": 0,
                "mem_scale_up_threshold": 0,
                "metric_lookback_seconds": 0,
                "min_containers": 0,
                "min_cpu_threshold": 0,
                "minimum_memory": 0,
                "percentile": 0,
                "post_release_cooldown_seconds": 0,
                "post_scale_down_cooldown_seconds": 0,
                "post_scale_up_cooldown_seconds": 0,
                "scale_down_step": 0,
                "scale_up_step": 0,
                "scaling_enabled": False,
            }],
            "container_count": 0,
            "container_memory_limit": 0,
            "container_profile": "string",
            "force_zero_downtime": False,
            "process_type": "string",
            "simple_health_check": False,
        }])
    
    const appResource = new aptible.App("appResource", {
        envId: 0,
        handle: "string",
        aptibleAppId: "string",
        config: {
            string: "string",
        },
        services: [{
            autoscalingPolicies: [{
                autoscalingType: "string",
                maxContainers: 0,
                maxCpuThreshold: 0,
                maximumMemory: 0,
                memCpuRatioCThreshold: 0,
                memCpuRatioRThreshold: 0,
                memScaleDownThreshold: 0,
                memScaleUpThreshold: 0,
                metricLookbackSeconds: 0,
                minContainers: 0,
                minCpuThreshold: 0,
                minimumMemory: 0,
                percentile: 0,
                postReleaseCooldownSeconds: 0,
                postScaleDownCooldownSeconds: 0,
                postScaleUpCooldownSeconds: 0,
                scaleDownStep: 0,
                scaleUpStep: 0,
                scalingEnabled: false,
            }],
            containerCount: 0,
            containerMemoryLimit: 0,
            containerProfile: "string",
            forceZeroDowntime: false,
            processType: "string",
            simpleHealthCheck: false,
        }],
    });
    
    type: aptible:App
    properties:
        aptibleAppId: string
        config:
            string: string
        envId: 0
        handle: string
        services:
            - autoscalingPolicies:
                - autoscalingType: string
                  maxContainers: 0
                  maxCpuThreshold: 0
                  maximumMemory: 0
                  memCpuRatioCThreshold: 0
                  memCpuRatioRThreshold: 0
                  memScaleDownThreshold: 0
                  memScaleUpThreshold: 0
                  metricLookbackSeconds: 0
                  minContainers: 0
                  minCpuThreshold: 0
                  minimumMemory: 0
                  percentile: 0
                  postReleaseCooldownSeconds: 0
                  postScaleDownCooldownSeconds: 0
                  postScaleUpCooldownSeconds: 0
                  scaleDownStep: 0
                  scaleUpStep: 0
                  scalingEnabled: false
              containerCount: 0
              containerMemoryLimit: 0
              containerProfile: string
              forceZeroDowntime: false
              processType: string
              simpleHealthCheck: false
    

    App Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The App resource accepts the following input properties:

    EnvId double
    The ID of the environment you would like to deploy your App in. See main provider documentation for more on how to determine what you should use for env_id.
    Handle string
    The handle for the App. This must be all lower case, and only contain letters, numbers, -, _, or .
    AptibleAppId string
    Config Dictionary<string, string>
    The configuration for the App. This should be a map of KEY = VALUE.
    Services List<AppService>
    A block to manage scaling for services. See the main provider docs for additional details.
    EnvId float64
    The ID of the environment you would like to deploy your App in. See main provider documentation for more on how to determine what you should use for env_id.
    Handle string
    The handle for the App. This must be all lower case, and only contain letters, numbers, -, _, or .
    AptibleAppId string
    Config map[string]string
    The configuration for the App. This should be a map of KEY = VALUE.
    Services []AppServiceArgs
    A block to manage scaling for services. See the main provider docs for additional details.
    envId Double
    The ID of the environment you would like to deploy your App in. See main provider documentation for more on how to determine what you should use for env_id.
    handle String
    The handle for the App. This must be all lower case, and only contain letters, numbers, -, _, or .
    aptibleAppId String
    config Map<String,String>
    The configuration for the App. This should be a map of KEY = VALUE.
    services List<AppService>
    A block to manage scaling for services. See the main provider docs for additional details.
    envId number
    The ID of the environment you would like to deploy your App in. See main provider documentation for more on how to determine what you should use for env_id.
    handle string
    The handle for the App. This must be all lower case, and only contain letters, numbers, -, _, or .
    aptibleAppId string
    config {[key: string]: string}
    The configuration for the App. This should be a map of KEY = VALUE.
    services AppService[]
    A block to manage scaling for services. See the main provider docs for additional details.
    env_id float
    The ID of the environment you would like to deploy your App in. See main provider documentation for more on how to determine what you should use for env_id.
    handle str
    The handle for the App. This must be all lower case, and only contain letters, numbers, -, _, or .
    aptible_app_id str
    config Mapping[str, str]
    The configuration for the App. This should be a map of KEY = VALUE.
    services Sequence[AppServiceArgs]
    A block to manage scaling for services. See the main provider docs for additional details.
    envId Number
    The ID of the environment you would like to deploy your App in. See main provider documentation for more on how to determine what you should use for env_id.
    handle String
    The handle for the App. This must be all lower case, and only contain letters, numbers, -, _, or .
    aptibleAppId String
    config Map<String>
    The configuration for the App. This should be a map of KEY = VALUE.
    services List<Property Map>
    A block to manage scaling for services. See the main provider docs for additional details.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the App resource produces the following output properties:

    AppId double
    The unique ID of the application.
    GitRepo string
    The git remote associated with the application.
    Id string
    The provider-assigned unique ID for this managed resource.
    AppId float64
    The unique ID of the application.
    GitRepo string
    The git remote associated with the application.
    Id string
    The provider-assigned unique ID for this managed resource.
    appId Double
    The unique ID of the application.
    gitRepo String
    The git remote associated with the application.
    id String
    The provider-assigned unique ID for this managed resource.
    appId number
    The unique ID of the application.
    gitRepo string
    The git remote associated with the application.
    id string
    The provider-assigned unique ID for this managed resource.
    app_id float
    The unique ID of the application.
    git_repo str
    The git remote associated with the application.
    id str
    The provider-assigned unique ID for this managed resource.
    appId Number
    The unique ID of the application.
    gitRepo String
    The git remote associated with the application.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing App Resource

    Get an existing App resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AppState, opts?: CustomResourceOptions): App
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            app_id: Optional[float] = None,
            aptible_app_id: Optional[str] = None,
            config: Optional[Mapping[str, str]] = None,
            env_id: Optional[float] = None,
            git_repo: Optional[str] = None,
            handle: Optional[str] = None,
            services: Optional[Sequence[AppServiceArgs]] = None) -> App
    func GetApp(ctx *Context, name string, id IDInput, state *AppState, opts ...ResourceOption) (*App, error)
    public static App Get(string name, Input<string> id, AppState? state, CustomResourceOptions? opts = null)
    public static App get(String name, Output<String> id, AppState state, CustomResourceOptions options)
    resources:  _:    type: aptible:App    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AppId double
    The unique ID of the application.
    AptibleAppId string
    Config Dictionary<string, string>
    The configuration for the App. This should be a map of KEY = VALUE.
    EnvId double
    The ID of the environment you would like to deploy your App in. See main provider documentation for more on how to determine what you should use for env_id.
    GitRepo string
    The git remote associated with the application.
    Handle string
    The handle for the App. This must be all lower case, and only contain letters, numbers, -, _, or .
    Services List<AppService>
    A block to manage scaling for services. See the main provider docs for additional details.
    AppId float64
    The unique ID of the application.
    AptibleAppId string
    Config map[string]string
    The configuration for the App. This should be a map of KEY = VALUE.
    EnvId float64
    The ID of the environment you would like to deploy your App in. See main provider documentation for more on how to determine what you should use for env_id.
    GitRepo string
    The git remote associated with the application.
    Handle string
    The handle for the App. This must be all lower case, and only contain letters, numbers, -, _, or .
    Services []AppServiceArgs
    A block to manage scaling for services. See the main provider docs for additional details.
    appId Double
    The unique ID of the application.
    aptibleAppId String
    config Map<String,String>
    The configuration for the App. This should be a map of KEY = VALUE.
    envId Double
    The ID of the environment you would like to deploy your App in. See main provider documentation for more on how to determine what you should use for env_id.
    gitRepo String
    The git remote associated with the application.
    handle String
    The handle for the App. This must be all lower case, and only contain letters, numbers, -, _, or .
    services List<AppService>
    A block to manage scaling for services. See the main provider docs for additional details.
    appId number
    The unique ID of the application.
    aptibleAppId string
    config {[key: string]: string}
    The configuration for the App. This should be a map of KEY = VALUE.
    envId number
    The ID of the environment you would like to deploy your App in. See main provider documentation for more on how to determine what you should use for env_id.
    gitRepo string
    The git remote associated with the application.
    handle string
    The handle for the App. This must be all lower case, and only contain letters, numbers, -, _, or .
    services AppService[]
    A block to manage scaling for services. See the main provider docs for additional details.
    app_id float
    The unique ID of the application.
    aptible_app_id str
    config Mapping[str, str]
    The configuration for the App. This should be a map of KEY = VALUE.
    env_id float
    The ID of the environment you would like to deploy your App in. See main provider documentation for more on how to determine what you should use for env_id.
    git_repo str
    The git remote associated with the application.
    handle str
    The handle for the App. This must be all lower case, and only contain letters, numbers, -, _, or .
    services Sequence[AppServiceArgs]
    A block to manage scaling for services. See the main provider docs for additional details.
    appId Number
    The unique ID of the application.
    aptibleAppId String
    config Map<String>
    The configuration for the App. This should be a map of KEY = VALUE.
    envId Number
    The ID of the environment you would like to deploy your App in. See main provider documentation for more on how to determine what you should use for env_id.
    gitRepo String
    The git remote associated with the application.
    handle String
    The handle for the App. This must be all lower case, and only contain letters, numbers, -, _, or .
    services List<Property Map>
    A block to manage scaling for services. See the main provider docs for additional details.

    Supporting Types

    AppService, AppServiceArgs

    AutoscalingPolicies List<AppServiceAutoscalingPolicy>
    A block to manage autoscaling for services. See the main provider docs for additional details.
    ContainerCount double
    The number of unique containers running the service.
    ContainerMemoryLimit double
    The memory limit (in MB) of the service's containers.
    ContainerProfile string
    Changes the CPU:RAM ratio of the service's containers.
    ForceZeroDowntime bool
    For services without endpoints, force a zero-downtime release and leverage docker healthchecks for the containers. Please note that docker healthchecks are required unless simple_health_check is enabled. For more information please see the docs.
    ProcessType string
    The process_type maps directly to the Service name used in the Procfile. If you are not using a Procfile, you will have a single Service with the process_type of cmd.
    ServiceSizingPolicies List<AppServiceServiceSizingPolicy>
    Deprecated (Optional) A block to manage autoscaling for services. See the main provider docs for additional details.

    Deprecated: Deprecated

    SimpleHealthCheck bool
    For services without endpoints, if force_zero_downtime is enabled, do a simple uptime check instead of using docker healthchecks.
    AutoscalingPolicies []AppServiceAutoscalingPolicy
    A block to manage autoscaling for services. See the main provider docs for additional details.
    ContainerCount float64
    The number of unique containers running the service.
    ContainerMemoryLimit float64
    The memory limit (in MB) of the service's containers.
    ContainerProfile string
    Changes the CPU:RAM ratio of the service's containers.
    ForceZeroDowntime bool
    For services without endpoints, force a zero-downtime release and leverage docker healthchecks for the containers. Please note that docker healthchecks are required unless simple_health_check is enabled. For more information please see the docs.
    ProcessType string
    The process_type maps directly to the Service name used in the Procfile. If you are not using a Procfile, you will have a single Service with the process_type of cmd.
    ServiceSizingPolicies []AppServiceServiceSizingPolicy
    Deprecated (Optional) A block to manage autoscaling for services. See the main provider docs for additional details.

    Deprecated: Deprecated

    SimpleHealthCheck bool
    For services without endpoints, if force_zero_downtime is enabled, do a simple uptime check instead of using docker healthchecks.
    autoscalingPolicies List<AppServiceAutoscalingPolicy>
    A block to manage autoscaling for services. See the main provider docs for additional details.
    containerCount Double
    The number of unique containers running the service.
    containerMemoryLimit Double
    The memory limit (in MB) of the service's containers.
    containerProfile String
    Changes the CPU:RAM ratio of the service's containers.
    forceZeroDowntime Boolean
    For services without endpoints, force a zero-downtime release and leverage docker healthchecks for the containers. Please note that docker healthchecks are required unless simple_health_check is enabled. For more information please see the docs.
    processType String
    The process_type maps directly to the Service name used in the Procfile. If you are not using a Procfile, you will have a single Service with the process_type of cmd.
    serviceSizingPolicies List<AppServiceServiceSizingPolicy>
    Deprecated (Optional) A block to manage autoscaling for services. See the main provider docs for additional details.

    Deprecated: Deprecated

    simpleHealthCheck Boolean
    For services without endpoints, if force_zero_downtime is enabled, do a simple uptime check instead of using docker healthchecks.
    autoscalingPolicies AppServiceAutoscalingPolicy[]
    A block to manage autoscaling for services. See the main provider docs for additional details.
    containerCount number
    The number of unique containers running the service.
    containerMemoryLimit number
    The memory limit (in MB) of the service's containers.
    containerProfile string
    Changes the CPU:RAM ratio of the service's containers.
    forceZeroDowntime boolean
    For services without endpoints, force a zero-downtime release and leverage docker healthchecks for the containers. Please note that docker healthchecks are required unless simple_health_check is enabled. For more information please see the docs.
    processType string
    The process_type maps directly to the Service name used in the Procfile. If you are not using a Procfile, you will have a single Service with the process_type of cmd.
    serviceSizingPolicies AppServiceServiceSizingPolicy[]
    Deprecated (Optional) A block to manage autoscaling for services. See the main provider docs for additional details.

    Deprecated: Deprecated

    simpleHealthCheck boolean
    For services without endpoints, if force_zero_downtime is enabled, do a simple uptime check instead of using docker healthchecks.
    autoscaling_policies Sequence[AppServiceAutoscalingPolicy]
    A block to manage autoscaling for services. See the main provider docs for additional details.
    container_count float
    The number of unique containers running the service.
    container_memory_limit float
    The memory limit (in MB) of the service's containers.
    container_profile str
    Changes the CPU:RAM ratio of the service's containers.
    force_zero_downtime bool
    For services without endpoints, force a zero-downtime release and leverage docker healthchecks for the containers. Please note that docker healthchecks are required unless simple_health_check is enabled. For more information please see the docs.
    process_type str
    The process_type maps directly to the Service name used in the Procfile. If you are not using a Procfile, you will have a single Service with the process_type of cmd.
    service_sizing_policies Sequence[AppServiceServiceSizingPolicy]
    Deprecated (Optional) A block to manage autoscaling for services. See the main provider docs for additional details.

    Deprecated: Deprecated

    simple_health_check bool
    For services without endpoints, if force_zero_downtime is enabled, do a simple uptime check instead of using docker healthchecks.
    autoscalingPolicies List<Property Map>
    A block to manage autoscaling for services. See the main provider docs for additional details.
    containerCount Number
    The number of unique containers running the service.
    containerMemoryLimit Number
    The memory limit (in MB) of the service's containers.
    containerProfile String
    Changes the CPU:RAM ratio of the service's containers.
    forceZeroDowntime Boolean
    For services without endpoints, force a zero-downtime release and leverage docker healthchecks for the containers. Please note that docker healthchecks are required unless simple_health_check is enabled. For more information please see the docs.
    processType String
    The process_type maps directly to the Service name used in the Procfile. If you are not using a Procfile, you will have a single Service with the process_type of cmd.
    serviceSizingPolicies List<Property Map>
    Deprecated (Optional) A block to manage autoscaling for services. See the main provider docs for additional details.

    Deprecated: Deprecated

    simpleHealthCheck Boolean
    For services without endpoints, if force_zero_downtime is enabled, do a simple uptime check instead of using docker healthchecks.

    AppServiceAutoscalingPolicy, AppServiceAutoscalingPolicyArgs

    AutoscalingType string
    The type of autoscaling. Must be either horizontal or vertical.
    MaxContainers double
    Horizontal autoscaling only - Sets the highest container count to which the service can be scaled up to by Autoscaler.
    MaxCpuThreshold double
    Horizontal autoscaling only - Specifies the percentage of the current CPU usage at which an up-scaling action is triggered.
    MaximumMemory double
    Vertical autoscaling only - Defines the upper memory threshold, capping the maximum memory allocation possible through Autoscaler. If blank, the container can scale to the largest size available.
    MemCpuRatioCThreshold double
    Sets the Memory-to-CPU ratio threshold, below which the service is transitioned to a C (Compute Optimized) profile.
    MemCpuRatioRThreshold double
    Establishes the ratio of Memory (in GB) to CPU (in CPUs) at which values exceeding the threshold prompt a shift to an R (Memory Optimized) profile.
    MemScaleDownThreshold double
    Vertical autoscaling only - Specifies the percentage of the current memory limit at which the service’s memory usage triggers a down-scaling action.
    MemScaleUpThreshold double
    Vertical autoscaling only - Specifies the percentage of the current memory limit at which the service’s memory usage triggers an up-scaling action.
    MetricLookbackSeconds double
    The duration in seconds for retrieving past performance metrics.
    MinContainers double
    Horizontal autoscaling only - Sets the lowest container count to which the service can be scaled down by Autoscaler.
    MinCpuThreshold double
    Horizontal autoscaling only - Specifies the percentage of the current CPU usage at which a down-scaling action is triggered.
    MinimumMemory double
    Vertical autoscaling only - Sets the lowest memory limit to which the service can be scaled down by Autoscaler.
    Percentile double
    The percentile for evaluating metrics.
    PostReleaseCooldownSeconds double
    The time in seconds to ignore in metrics following a deploy to allow for service stabilization.
    PostScaleDownCooldownSeconds double
    The waiting period in seconds after an automated scale-down before another scaling action can be considered.
    PostScaleUpCooldownSeconds double
    The waiting period in seconds after an automated scale-up before another scaling action can be considered.
    ScaleDownStep double
    Horizontal autoscaling only - Sets the amount of containers to remove when autoscaling (ex: a value of 2 will go from 4->2->1). Container count will never exceed the configured minimum.
    ScaleUpStep double
    Horizontal autoscaling only - Sets the amount of containers to add when autoscaling (ex: a value of 2 will go from 1->3->5). Container count will never exceed the configured maximum.
    ScalingEnabled bool
    AutoscalingType string
    The type of autoscaling. Must be either horizontal or vertical.
    MaxContainers float64
    Horizontal autoscaling only - Sets the highest container count to which the service can be scaled up to by Autoscaler.
    MaxCpuThreshold float64
    Horizontal autoscaling only - Specifies the percentage of the current CPU usage at which an up-scaling action is triggered.
    MaximumMemory float64
    Vertical autoscaling only - Defines the upper memory threshold, capping the maximum memory allocation possible through Autoscaler. If blank, the container can scale to the largest size available.
    MemCpuRatioCThreshold float64
    Sets the Memory-to-CPU ratio threshold, below which the service is transitioned to a C (Compute Optimized) profile.
    MemCpuRatioRThreshold float64
    Establishes the ratio of Memory (in GB) to CPU (in CPUs) at which values exceeding the threshold prompt a shift to an R (Memory Optimized) profile.
    MemScaleDownThreshold float64
    Vertical autoscaling only - Specifies the percentage of the current memory limit at which the service’s memory usage triggers a down-scaling action.
    MemScaleUpThreshold float64
    Vertical autoscaling only - Specifies the percentage of the current memory limit at which the service’s memory usage triggers an up-scaling action.
    MetricLookbackSeconds float64
    The duration in seconds for retrieving past performance metrics.
    MinContainers float64
    Horizontal autoscaling only - Sets the lowest container count to which the service can be scaled down by Autoscaler.
    MinCpuThreshold float64
    Horizontal autoscaling only - Specifies the percentage of the current CPU usage at which a down-scaling action is triggered.
    MinimumMemory float64
    Vertical autoscaling only - Sets the lowest memory limit to which the service can be scaled down by Autoscaler.
    Percentile float64
    The percentile for evaluating metrics.
    PostReleaseCooldownSeconds float64
    The time in seconds to ignore in metrics following a deploy to allow for service stabilization.
    PostScaleDownCooldownSeconds float64
    The waiting period in seconds after an automated scale-down before another scaling action can be considered.
    PostScaleUpCooldownSeconds float64
    The waiting period in seconds after an automated scale-up before another scaling action can be considered.
    ScaleDownStep float64
    Horizontal autoscaling only - Sets the amount of containers to remove when autoscaling (ex: a value of 2 will go from 4->2->1). Container count will never exceed the configured minimum.
    ScaleUpStep float64
    Horizontal autoscaling only - Sets the amount of containers to add when autoscaling (ex: a value of 2 will go from 1->3->5). Container count will never exceed the configured maximum.
    ScalingEnabled bool
    autoscalingType String
    The type of autoscaling. Must be either horizontal or vertical.
    maxContainers Double
    Horizontal autoscaling only - Sets the highest container count to which the service can be scaled up to by Autoscaler.
    maxCpuThreshold Double
    Horizontal autoscaling only - Specifies the percentage of the current CPU usage at which an up-scaling action is triggered.
    maximumMemory Double
    Vertical autoscaling only - Defines the upper memory threshold, capping the maximum memory allocation possible through Autoscaler. If blank, the container can scale to the largest size available.
    memCpuRatioCThreshold Double
    Sets the Memory-to-CPU ratio threshold, below which the service is transitioned to a C (Compute Optimized) profile.
    memCpuRatioRThreshold Double
    Establishes the ratio of Memory (in GB) to CPU (in CPUs) at which values exceeding the threshold prompt a shift to an R (Memory Optimized) profile.
    memScaleDownThreshold Double
    Vertical autoscaling only - Specifies the percentage of the current memory limit at which the service’s memory usage triggers a down-scaling action.
    memScaleUpThreshold Double
    Vertical autoscaling only - Specifies the percentage of the current memory limit at which the service’s memory usage triggers an up-scaling action.
    metricLookbackSeconds Double
    The duration in seconds for retrieving past performance metrics.
    minContainers Double
    Horizontal autoscaling only - Sets the lowest container count to which the service can be scaled down by Autoscaler.
    minCpuThreshold Double
    Horizontal autoscaling only - Specifies the percentage of the current CPU usage at which a down-scaling action is triggered.
    minimumMemory Double
    Vertical autoscaling only - Sets the lowest memory limit to which the service can be scaled down by Autoscaler.
    percentile Double
    The percentile for evaluating metrics.
    postReleaseCooldownSeconds Double
    The time in seconds to ignore in metrics following a deploy to allow for service stabilization.
    postScaleDownCooldownSeconds Double
    The waiting period in seconds after an automated scale-down before another scaling action can be considered.
    postScaleUpCooldownSeconds Double
    The waiting period in seconds after an automated scale-up before another scaling action can be considered.
    scaleDownStep Double
    Horizontal autoscaling only - Sets the amount of containers to remove when autoscaling (ex: a value of 2 will go from 4->2->1). Container count will never exceed the configured minimum.
    scaleUpStep Double
    Horizontal autoscaling only - Sets the amount of containers to add when autoscaling (ex: a value of 2 will go from 1->3->5). Container count will never exceed the configured maximum.
    scalingEnabled Boolean
    autoscalingType string
    The type of autoscaling. Must be either horizontal or vertical.
    maxContainers number
    Horizontal autoscaling only - Sets the highest container count to which the service can be scaled up to by Autoscaler.
    maxCpuThreshold number
    Horizontal autoscaling only - Specifies the percentage of the current CPU usage at which an up-scaling action is triggered.
    maximumMemory number
    Vertical autoscaling only - Defines the upper memory threshold, capping the maximum memory allocation possible through Autoscaler. If blank, the container can scale to the largest size available.
    memCpuRatioCThreshold number
    Sets the Memory-to-CPU ratio threshold, below which the service is transitioned to a C (Compute Optimized) profile.
    memCpuRatioRThreshold number
    Establishes the ratio of Memory (in GB) to CPU (in CPUs) at which values exceeding the threshold prompt a shift to an R (Memory Optimized) profile.
    memScaleDownThreshold number
    Vertical autoscaling only - Specifies the percentage of the current memory limit at which the service’s memory usage triggers a down-scaling action.
    memScaleUpThreshold number
    Vertical autoscaling only - Specifies the percentage of the current memory limit at which the service’s memory usage triggers an up-scaling action.
    metricLookbackSeconds number
    The duration in seconds for retrieving past performance metrics.
    minContainers number
    Horizontal autoscaling only - Sets the lowest container count to which the service can be scaled down by Autoscaler.
    minCpuThreshold number
    Horizontal autoscaling only - Specifies the percentage of the current CPU usage at which a down-scaling action is triggered.
    minimumMemory number
    Vertical autoscaling only - Sets the lowest memory limit to which the service can be scaled down by Autoscaler.
    percentile number
    The percentile for evaluating metrics.
    postReleaseCooldownSeconds number
    The time in seconds to ignore in metrics following a deploy to allow for service stabilization.
    postScaleDownCooldownSeconds number
    The waiting period in seconds after an automated scale-down before another scaling action can be considered.
    postScaleUpCooldownSeconds number
    The waiting period in seconds after an automated scale-up before another scaling action can be considered.
    scaleDownStep number
    Horizontal autoscaling only - Sets the amount of containers to remove when autoscaling (ex: a value of 2 will go from 4->2->1). Container count will never exceed the configured minimum.
    scaleUpStep number
    Horizontal autoscaling only - Sets the amount of containers to add when autoscaling (ex: a value of 2 will go from 1->3->5). Container count will never exceed the configured maximum.
    scalingEnabled boolean
    autoscaling_type str
    The type of autoscaling. Must be either horizontal or vertical.
    max_containers float
    Horizontal autoscaling only - Sets the highest container count to which the service can be scaled up to by Autoscaler.
    max_cpu_threshold float
    Horizontal autoscaling only - Specifies the percentage of the current CPU usage at which an up-scaling action is triggered.
    maximum_memory float
    Vertical autoscaling only - Defines the upper memory threshold, capping the maximum memory allocation possible through Autoscaler. If blank, the container can scale to the largest size available.
    mem_cpu_ratio_c_threshold float
    Sets the Memory-to-CPU ratio threshold, below which the service is transitioned to a C (Compute Optimized) profile.
    mem_cpu_ratio_r_threshold float
    Establishes the ratio of Memory (in GB) to CPU (in CPUs) at which values exceeding the threshold prompt a shift to an R (Memory Optimized) profile.
    mem_scale_down_threshold float
    Vertical autoscaling only - Specifies the percentage of the current memory limit at which the service’s memory usage triggers a down-scaling action.
    mem_scale_up_threshold float
    Vertical autoscaling only - Specifies the percentage of the current memory limit at which the service’s memory usage triggers an up-scaling action.
    metric_lookback_seconds float
    The duration in seconds for retrieving past performance metrics.
    min_containers float
    Horizontal autoscaling only - Sets the lowest container count to which the service can be scaled down by Autoscaler.
    min_cpu_threshold float
    Horizontal autoscaling only - Specifies the percentage of the current CPU usage at which a down-scaling action is triggered.
    minimum_memory float
    Vertical autoscaling only - Sets the lowest memory limit to which the service can be scaled down by Autoscaler.
    percentile float
    The percentile for evaluating metrics.
    post_release_cooldown_seconds float
    The time in seconds to ignore in metrics following a deploy to allow for service stabilization.
    post_scale_down_cooldown_seconds float
    The waiting period in seconds after an automated scale-down before another scaling action can be considered.
    post_scale_up_cooldown_seconds float
    The waiting period in seconds after an automated scale-up before another scaling action can be considered.
    scale_down_step float
    Horizontal autoscaling only - Sets the amount of containers to remove when autoscaling (ex: a value of 2 will go from 4->2->1). Container count will never exceed the configured minimum.
    scale_up_step float
    Horizontal autoscaling only - Sets the amount of containers to add when autoscaling (ex: a value of 2 will go from 1->3->5). Container count will never exceed the configured maximum.
    scaling_enabled bool
    autoscalingType String
    The type of autoscaling. Must be either horizontal or vertical.
    maxContainers Number
    Horizontal autoscaling only - Sets the highest container count to which the service can be scaled up to by Autoscaler.
    maxCpuThreshold Number
    Horizontal autoscaling only - Specifies the percentage of the current CPU usage at which an up-scaling action is triggered.
    maximumMemory Number
    Vertical autoscaling only - Defines the upper memory threshold, capping the maximum memory allocation possible through Autoscaler. If blank, the container can scale to the largest size available.
    memCpuRatioCThreshold Number
    Sets the Memory-to-CPU ratio threshold, below which the service is transitioned to a C (Compute Optimized) profile.
    memCpuRatioRThreshold Number
    Establishes the ratio of Memory (in GB) to CPU (in CPUs) at which values exceeding the threshold prompt a shift to an R (Memory Optimized) profile.
    memScaleDownThreshold Number
    Vertical autoscaling only - Specifies the percentage of the current memory limit at which the service’s memory usage triggers a down-scaling action.
    memScaleUpThreshold Number
    Vertical autoscaling only - Specifies the percentage of the current memory limit at which the service’s memory usage triggers an up-scaling action.
    metricLookbackSeconds Number
    The duration in seconds for retrieving past performance metrics.
    minContainers Number
    Horizontal autoscaling only - Sets the lowest container count to which the service can be scaled down by Autoscaler.
    minCpuThreshold Number
    Horizontal autoscaling only - Specifies the percentage of the current CPU usage at which a down-scaling action is triggered.
    minimumMemory Number
    Vertical autoscaling only - Sets the lowest memory limit to which the service can be scaled down by Autoscaler.
    percentile Number
    The percentile for evaluating metrics.
    postReleaseCooldownSeconds Number
    The time in seconds to ignore in metrics following a deploy to allow for service stabilization.
    postScaleDownCooldownSeconds Number
    The waiting period in seconds after an automated scale-down before another scaling action can be considered.
    postScaleUpCooldownSeconds Number
    The waiting period in seconds after an automated scale-up before another scaling action can be considered.
    scaleDownStep Number
    Horizontal autoscaling only - Sets the amount of containers to remove when autoscaling (ex: a value of 2 will go from 4->2->1). Container count will never exceed the configured minimum.
    scaleUpStep Number
    Horizontal autoscaling only - Sets the amount of containers to add when autoscaling (ex: a value of 2 will go from 1->3->5). Container count will never exceed the configured maximum.
    scalingEnabled Boolean

    AppServiceServiceSizingPolicy, AppServiceServiceSizingPolicyArgs

    AutoscalingType string
    The type of autoscaling, must be either 'vertical' or 'horizontal'.
    MaxContainers double
    The maximum number of containers for scaling.
    MaxCpuThreshold double
    The maximum CPU utilization threshold for scaling.
    MaximumMemory double
    The maximum memory allocation in MB.
    MemCpuRatioCThreshold double
    Sets the Memory-to-CPU ratio threshold, below which the service is transitioned to a C (Compute Optimized) profile.
    MemCpuRatioRThreshold double
    Establishes the ratio of Memory (in GB) to CPU (in CPUs) at which values exceeding the threshold prompt a shift to an R (Memory Optimized) profile.
    MemScaleDownThreshold double
    The memory usage threshold for scaling down.
    MemScaleUpThreshold double
    The memory usage threshold for scaling up.
    MetricLookbackSeconds double
    The lookback period for metrics in seconds.
    MinContainers double
    The minimum number of containers for scaling.
    MinCpuThreshold double
    The minimum CPU utilization threshold for scaling.
    MinimumMemory double
    The minimum memory allocation in MB.
    Percentile double
    The percentile threshold used for scaling.
    PostReleaseCooldownSeconds double
    Seconds to ignore in metrics after a release event.
    PostScaleDownCooldownSeconds double
    Cooldown period in seconds after a scale-down event.
    PostScaleUpCooldownSeconds double
    Cooldown period in seconds after a scale-up event.
    ScaleDownStep double
    The number of containers to remove in each scale-down event.
    ScaleUpStep double
    The number of containers to add in each scale-up event.
    ScalingEnabled bool
    AutoscalingType string
    The type of autoscaling, must be either 'vertical' or 'horizontal'.
    MaxContainers float64
    The maximum number of containers for scaling.
    MaxCpuThreshold float64
    The maximum CPU utilization threshold for scaling.
    MaximumMemory float64
    The maximum memory allocation in MB.
    MemCpuRatioCThreshold float64
    Sets the Memory-to-CPU ratio threshold, below which the service is transitioned to a C (Compute Optimized) profile.
    MemCpuRatioRThreshold float64
    Establishes the ratio of Memory (in GB) to CPU (in CPUs) at which values exceeding the threshold prompt a shift to an R (Memory Optimized) profile.
    MemScaleDownThreshold float64
    The memory usage threshold for scaling down.
    MemScaleUpThreshold float64
    The memory usage threshold for scaling up.
    MetricLookbackSeconds float64
    The lookback period for metrics in seconds.
    MinContainers float64
    The minimum number of containers for scaling.
    MinCpuThreshold float64
    The minimum CPU utilization threshold for scaling.
    MinimumMemory float64
    The minimum memory allocation in MB.
    Percentile float64
    The percentile threshold used for scaling.
    PostReleaseCooldownSeconds float64
    Seconds to ignore in metrics after a release event.
    PostScaleDownCooldownSeconds float64
    Cooldown period in seconds after a scale-down event.
    PostScaleUpCooldownSeconds float64
    Cooldown period in seconds after a scale-up event.
    ScaleDownStep float64
    The number of containers to remove in each scale-down event.
    ScaleUpStep float64
    The number of containers to add in each scale-up event.
    ScalingEnabled bool
    autoscalingType String
    The type of autoscaling, must be either 'vertical' or 'horizontal'.
    maxContainers Double
    The maximum number of containers for scaling.
    maxCpuThreshold Double
    The maximum CPU utilization threshold for scaling.
    maximumMemory Double
    The maximum memory allocation in MB.
    memCpuRatioCThreshold Double
    Sets the Memory-to-CPU ratio threshold, below which the service is transitioned to a C (Compute Optimized) profile.
    memCpuRatioRThreshold Double
    Establishes the ratio of Memory (in GB) to CPU (in CPUs) at which values exceeding the threshold prompt a shift to an R (Memory Optimized) profile.
    memScaleDownThreshold Double
    The memory usage threshold for scaling down.
    memScaleUpThreshold Double
    The memory usage threshold for scaling up.
    metricLookbackSeconds Double
    The lookback period for metrics in seconds.
    minContainers Double
    The minimum number of containers for scaling.
    minCpuThreshold Double
    The minimum CPU utilization threshold for scaling.
    minimumMemory Double
    The minimum memory allocation in MB.
    percentile Double
    The percentile threshold used for scaling.
    postReleaseCooldownSeconds Double
    Seconds to ignore in metrics after a release event.
    postScaleDownCooldownSeconds Double
    Cooldown period in seconds after a scale-down event.
    postScaleUpCooldownSeconds Double
    Cooldown period in seconds after a scale-up event.
    scaleDownStep Double
    The number of containers to remove in each scale-down event.
    scaleUpStep Double
    The number of containers to add in each scale-up event.
    scalingEnabled Boolean
    autoscalingType string
    The type of autoscaling, must be either 'vertical' or 'horizontal'.
    maxContainers number
    The maximum number of containers for scaling.
    maxCpuThreshold number
    The maximum CPU utilization threshold for scaling.
    maximumMemory number
    The maximum memory allocation in MB.
    memCpuRatioCThreshold number
    Sets the Memory-to-CPU ratio threshold, below which the service is transitioned to a C (Compute Optimized) profile.
    memCpuRatioRThreshold number
    Establishes the ratio of Memory (in GB) to CPU (in CPUs) at which values exceeding the threshold prompt a shift to an R (Memory Optimized) profile.
    memScaleDownThreshold number
    The memory usage threshold for scaling down.
    memScaleUpThreshold number
    The memory usage threshold for scaling up.
    metricLookbackSeconds number
    The lookback period for metrics in seconds.
    minContainers number
    The minimum number of containers for scaling.
    minCpuThreshold number
    The minimum CPU utilization threshold for scaling.
    minimumMemory number
    The minimum memory allocation in MB.
    percentile number
    The percentile threshold used for scaling.
    postReleaseCooldownSeconds number
    Seconds to ignore in metrics after a release event.
    postScaleDownCooldownSeconds number
    Cooldown period in seconds after a scale-down event.
    postScaleUpCooldownSeconds number
    Cooldown period in seconds after a scale-up event.
    scaleDownStep number
    The number of containers to remove in each scale-down event.
    scaleUpStep number
    The number of containers to add in each scale-up event.
    scalingEnabled boolean
    autoscaling_type str
    The type of autoscaling, must be either 'vertical' or 'horizontal'.
    max_containers float
    The maximum number of containers for scaling.
    max_cpu_threshold float
    The maximum CPU utilization threshold for scaling.
    maximum_memory float
    The maximum memory allocation in MB.
    mem_cpu_ratio_c_threshold float
    Sets the Memory-to-CPU ratio threshold, below which the service is transitioned to a C (Compute Optimized) profile.
    mem_cpu_ratio_r_threshold float
    Establishes the ratio of Memory (in GB) to CPU (in CPUs) at which values exceeding the threshold prompt a shift to an R (Memory Optimized) profile.
    mem_scale_down_threshold float
    The memory usage threshold for scaling down.
    mem_scale_up_threshold float
    The memory usage threshold for scaling up.
    metric_lookback_seconds float
    The lookback period for metrics in seconds.
    min_containers float
    The minimum number of containers for scaling.
    min_cpu_threshold float
    The minimum CPU utilization threshold for scaling.
    minimum_memory float
    The minimum memory allocation in MB.
    percentile float
    The percentile threshold used for scaling.
    post_release_cooldown_seconds float
    Seconds to ignore in metrics after a release event.
    post_scale_down_cooldown_seconds float
    Cooldown period in seconds after a scale-down event.
    post_scale_up_cooldown_seconds float
    Cooldown period in seconds after a scale-up event.
    scale_down_step float
    The number of containers to remove in each scale-down event.
    scale_up_step float
    The number of containers to add in each scale-up event.
    scaling_enabled bool
    autoscalingType String
    The type of autoscaling, must be either 'vertical' or 'horizontal'.
    maxContainers Number
    The maximum number of containers for scaling.
    maxCpuThreshold Number
    The maximum CPU utilization threshold for scaling.
    maximumMemory Number
    The maximum memory allocation in MB.
    memCpuRatioCThreshold Number
    Sets the Memory-to-CPU ratio threshold, below which the service is transitioned to a C (Compute Optimized) profile.
    memCpuRatioRThreshold Number
    Establishes the ratio of Memory (in GB) to CPU (in CPUs) at which values exceeding the threshold prompt a shift to an R (Memory Optimized) profile.
    memScaleDownThreshold Number
    The memory usage threshold for scaling down.
    memScaleUpThreshold Number
    The memory usage threshold for scaling up.
    metricLookbackSeconds Number
    The lookback period for metrics in seconds.
    minContainers Number
    The minimum number of containers for scaling.
    minCpuThreshold Number
    The minimum CPU utilization threshold for scaling.
    minimumMemory Number
    The minimum memory allocation in MB.
    percentile Number
    The percentile threshold used for scaling.
    postReleaseCooldownSeconds Number
    Seconds to ignore in metrics after a release event.
    postScaleDownCooldownSeconds Number
    Cooldown period in seconds after a scale-down event.
    postScaleUpCooldownSeconds Number
    Cooldown period in seconds after a scale-up event.
    scaleDownStep Number
    The number of containers to remove in each scale-down event.
    scaleUpStep Number
    The number of containers to add in each scale-up event.
    scalingEnabled Boolean

    Package Details

    Repository
    aptible aptible/terraform-provider-aptible
    License
    Notes
    This Pulumi package is based on the aptible Terraform Provider.
    aptible logo
    aptible 0.9.12 published on Monday, Apr 14, 2025 by aptible