Apprunner

This page documents function available when using the Apprunner module, created with @service Apprunner.

Index

Documentation

Main.Apprunner.associate_custom_domainMethod
associate_custom_domain(domain_name, service_arn)
associate_custom_domain(domain_name, service_arn, params::Dict{String,<:Any})

Associate your own domain name with the App Runner subdomain URL of your App Runner service. After you call AssociateCustomDomain and receive a successful response, use the information in the CustomDomain record that's returned to add CNAME records to your Domain Name System (DNS). For each mapped domain name, add a mapping to the target App Runner subdomain and one or more certificate validation records. App Runner then performs DNS validation to verify that you own or control the domain name that you associated. App Runner tracks domain validity in a certificate stored in AWS Certificate Manager (ACM).

Arguments

  • domain_name: A custom domain endpoint to associate. Specify a root domain (for example, example.com), a subdomain (for example, login.example.com or admin.login.example.com), or a wildcard (for example, *.example.com).
  • service_arn: The Amazon Resource Name (ARN) of the App Runner service that you want to associate a custom domain name with.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EnableWWWSubdomain": Set to true to associate the subdomain www.DomainName with the App Runner service in addition to the base domain. Default: true
source
Main.Apprunner.create_auto_scaling_configurationMethod
create_auto_scaling_configuration(auto_scaling_configuration_name)
create_auto_scaling_configuration(auto_scaling_configuration_name, params::Dict{String,<:Any})

Create an App Runner automatic scaling configuration resource. App Runner requires this resource when you create or update App Runner services and you require non-default auto scaling settings. You can share an auto scaling configuration across multiple services. Create multiple revisions of a configuration by calling this action multiple times using the same AutoScalingConfigurationName. The call returns incremental AutoScalingConfigurationRevision values. When you create a service and configure an auto scaling configuration resource, the service uses the latest active revision of the auto scaling configuration by default. You can optionally configure the service to use a specific revision. Configure a higher MinSize to increase the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is a higher minimal cost. Configure a lower MaxSize to control your cost. The tradeoff is lower responsiveness during peak demand.

Arguments

  • auto_scaling_configuration_name: A name for the auto scaling configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration. Prior to the release of Auto scale configuration enhancements, the name DefaultConfiguration was reserved. This restriction is no longer in place. You can now manage DefaultConfiguration the same way you manage your custom auto scaling configurations. This means you can do the following with the DefaultConfiguration that App Runner provides: Create new revisions of the DefaultConfiguration. Delete the revisions of the DefaultConfiguration. Delete the auto scaling configuration for which the App Runner DefaultConfiguration was created. If you delete the auto scaling configuration you can create another custom auto scaling configuration with the same DefaultConfiguration name. The original DefaultConfiguration resource provided by App Runner remains in your account unless you make changes to it.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxConcurrency": The maximum number of concurrent requests that you want an instance to process. If the number of concurrent requests exceeds this limit, App Runner scales up your service. Default: 100
  • "MaxSize": The maximum number of instances that your service scales up to. At most MaxSize instances actively serve traffic for your service. Default: 25
  • "MinSize": The minimum number of instances that App Runner provisions for your service. The service always has at least MinSize provisioned instances. Some of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset. App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code. Default: 1
  • "Tags": A list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair.
source
Main.Apprunner.create_connectionMethod
create_connection(connection_name, provider_type)
create_connection(connection_name, provider_type, params::Dict{String,<:Any})

Create an App Runner connection resource. App Runner requires a connection resource when you create App Runner services that access private repositories from certain third-party providers. You can share a connection across multiple services. A connection resource is needed to access GitHub and Bitbucket repositories. Both require a user interface approval process through the App Runner console before you can use the connection.

Arguments

  • connection_name: A name for the new connection. It must be unique across all App Runner connections for the Amazon Web Services account in the Amazon Web Services Region.
  • provider_type: The source repository provider.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Tags": A list of metadata items that you can associate with your connection resource. A tag is a key-value pair.
source
Main.Apprunner.create_observability_configurationMethod
create_observability_configuration(observability_configuration_name)
create_observability_configuration(observability_configuration_name, params::Dict{String,<:Any})

Create an App Runner observability configuration resource. App Runner requires this resource when you create or update App Runner services and you want to enable non-default observability features. You can share an observability configuration across multiple services. Create multiple revisions of a configuration by calling this action multiple times using the same ObservabilityConfigurationName. The call returns incremental ObservabilityConfigurationRevision values. When you create a service and configure an observability configuration resource, the service uses the latest active revision of the observability configuration by default. You can optionally configure the service to use a specific revision. The observability configuration resource is designed to configure multiple features (currently one feature, tracing). This action takes optional parameters that describe the configuration of these features (currently one parameter, TraceConfiguration). If you don't specify a feature parameter, App Runner doesn't enable the feature.

Arguments

  • observability_configuration_name: A name for the observability configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration. The name DefaultConfiguration is reserved. You can't use it to create a new observability configuration, and you can't create a revision of it. When you want to use your own observability configuration for your App Runner service, create a configuration with a different name, and then provide it when you create or update your service.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Tags": A list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair.
  • "TraceConfiguration": The configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing.
source
Main.Apprunner.create_serviceMethod
create_service(service_name, source_configuration)
create_service(service_name, source_configuration, params::Dict{String,<:Any})

Create an App Runner service. After the service is created, the action also automatically starts a deployment. This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.

Arguments

  • service_name: A name for the App Runner service. It must be unique across all the running App Runner services in your Amazon Web Services account in the Amazon Web Services Region.
  • source_configuration: The source to deploy to the App Runner service. It can be a code or an image repository.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AutoScalingConfigurationArn": The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service. If not provided, App Runner associates the latest revision of a default auto scaling configuration. Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3 Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability
  • "EncryptionConfiguration": An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. By default, App Runner uses an Amazon Web Services managed key.
  • "HealthCheckConfiguration": The settings for the health check that App Runner performs to monitor the health of the App Runner service.
  • "InstanceConfiguration": The runtime configuration of instances (scaling units) of your service.
  • "NetworkConfiguration": Configuration settings related to network traffic of the web application that the App Runner service runs.
  • "ObservabilityConfiguration": The observability configuration of your service.
  • "Tags": An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair.
source
Main.Apprunner.create_vpc_connectorMethod
create_vpc_connector(subnets, vpc_connector_name)
create_vpc_connector(subnets, vpc_connector_name, params::Dict{String,<:Any})

Create an App Runner VPC connector resource. App Runner requires this resource when you want to associate your App Runner service to a custom Amazon Virtual Private Cloud (Amazon VPC).

Arguments

  • subnets: A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify. App Runner currently only provides support for IPv4.
  • vpc_connector_name: A name for the VPC connector.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "SecurityGroups": A list of IDs of security groups that App Runner should use for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.
  • "Tags": A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.
source
Main.Apprunner.create_vpc_ingress_connectionMethod
create_vpc_ingress_connection(ingress_vpc_configuration, service_arn, vpc_ingress_connection_name)
create_vpc_ingress_connection(ingress_vpc_configuration, service_arn, vpc_ingress_connection_name, params::Dict{String,<:Any})

Create an App Runner VPC Ingress Connection resource. App Runner requires this resource when you want to associate your App Runner service with an Amazon VPC endpoint.

Arguments

  • ingress_vpc_configuration: Specifications for the customer’s Amazon VPC and the related Amazon Web Services PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource.
  • service_arn: The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.
  • vpc_ingress_connection_name: A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your Amazon Web Services account in the Amazon Web Services Region.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Tags": An optional list of metadata items that you can associate with the VPC Ingress Connection resource. A tag is a key-value pair.
source
Main.Apprunner.delete_auto_scaling_configurationMethod
delete_auto_scaling_configuration(auto_scaling_configuration_arn)
delete_auto_scaling_configuration(auto_scaling_configuration_arn, params::Dict{String,<:Any})

Delete an App Runner automatic scaling configuration resource. You can delete a top level auto scaling configuration, a specific revision of one, or all revisions associated with the top level configuration. You can't delete the default auto scaling configuration or a configuration that's used by one or more App Runner services.

Arguments

  • auto_scaling_configuration_arn: The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want to delete. The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either .../name or .../name/revision . If a revision isn't specified, the latest active revision is deleted.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "DeleteAllRevisions": Set to true to delete all of the revisions associated with the AutoScalingConfigurationArn parameter value. When DeleteAllRevisions is set to true, the only valid value for the Amazon Resource Name (ARN) is a partial ARN ending with: .../name.
source
Main.Apprunner.delete_connectionMethod
delete_connection(connection_arn)
delete_connection(connection_arn, params::Dict{String,<:Any})

Delete an App Runner connection. You must first ensure that there are no running App Runner services that use this connection. If there are any, the DeleteConnection action fails.

Arguments

  • connection_arn: The Amazon Resource Name (ARN) of the App Runner connection that you want to delete.
source
Main.Apprunner.delete_observability_configurationMethod
delete_observability_configuration(observability_configuration_arn)
delete_observability_configuration(observability_configuration_arn, params::Dict{String,<:Any})

Delete an App Runner observability configuration resource. You can delete a specific revision or the latest active revision. You can't delete a configuration that's used by one or more App Runner services.

Arguments

  • observability_configuration_arn: The Amazon Resource Name (ARN) of the App Runner observability configuration that you want to delete. The ARN can be a full observability configuration ARN, or a partial ARN ending with either .../name or .../name/revision . If a revision isn't specified, the latest active revision is deleted.
source
Main.Apprunner.delete_serviceMethod
delete_service(service_arn)
delete_service(service_arn, params::Dict{String,<:Any})

Delete an App Runner service. This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress. Make sure that you don't have any active VPCIngressConnections associated with the service you want to delete.

Arguments

  • service_arn: The Amazon Resource Name (ARN) of the App Runner service that you want to delete.
source
Main.Apprunner.delete_vpc_connectorMethod
delete_vpc_connector(vpc_connector_arn)
delete_vpc_connector(vpc_connector_arn, params::Dict{String,<:Any})

Delete an App Runner VPC connector resource. You can't delete a connector that's used by one or more App Runner services.

Arguments

  • vpc_connector_arn: The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to delete. The ARN must be a full VPC connector ARN.
source
Main.Apprunner.delete_vpc_ingress_connectionMethod
delete_vpc_ingress_connection(vpc_ingress_connection_arn)
delete_vpc_ingress_connection(vpc_ingress_connection_arn, params::Dict{String,<:Any})

Delete an App Runner VPC Ingress Connection resource that's associated with an App Runner service. The VPC Ingress Connection must be in one of the following states to be deleted: AVAILABLE FAILEDCREATION FAILEDUPDATE FAILED_DELETION

Arguments

  • vpc_ingress_connection_arn: The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you want to delete.
source
Main.Apprunner.describe_auto_scaling_configurationMethod
describe_auto_scaling_configuration(auto_scaling_configuration_arn)
describe_auto_scaling_configuration(auto_scaling_configuration_arn, params::Dict{String,<:Any})

Return a full description of an App Runner automatic scaling configuration resource.

Arguments

  • auto_scaling_configuration_arn: The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want a description for. The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either .../name or .../name/revision . If a revision isn't specified, the latest active revision is described.
source
Main.Apprunner.describe_custom_domainsMethod
describe_custom_domains(service_arn)
describe_custom_domains(service_arn, params::Dict{String,<:Any})

Return a description of custom domain names that are associated with an App Runner service.

Arguments

  • service_arn: The Amazon Resource Name (ARN) of the App Runner service that you want associated custom domain names to be described for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results that each response (result page) can include. It's used for a paginated request. If you don't specify MaxResults, the request retrieves all available results in a single response.
  • "NextToken": A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request. If you don't specify NextToken, the request retrieves the first result page.
source
Main.Apprunner.describe_observability_configurationMethod
describe_observability_configuration(observability_configuration_arn)
describe_observability_configuration(observability_configuration_arn, params::Dict{String,<:Any})

Return a full description of an App Runner observability configuration resource.

Arguments

  • observability_configuration_arn: The Amazon Resource Name (ARN) of the App Runner observability configuration that you want a description for. The ARN can be a full observability configuration ARN, or a partial ARN ending with either .../name or .../name/revision . If a revision isn't specified, the latest active revision is described.
source
Main.Apprunner.describe_serviceMethod
describe_service(service_arn)
describe_service(service_arn, params::Dict{String,<:Any})

Return a full description of an App Runner service.

Arguments

  • service_arn: The Amazon Resource Name (ARN) of the App Runner service that you want a description for.
source
Main.Apprunner.describe_vpc_connectorMethod
describe_vpc_connector(vpc_connector_arn)
describe_vpc_connector(vpc_connector_arn, params::Dict{String,<:Any})

Return a description of an App Runner VPC connector resource.

Arguments

  • vpc_connector_arn: The Amazon Resource Name (ARN) of the App Runner VPC connector that you want a description for. The ARN must be a full VPC connector ARN.
source
Main.Apprunner.describe_vpc_ingress_connectionMethod
describe_vpc_ingress_connection(vpc_ingress_connection_arn)
describe_vpc_ingress_connection(vpc_ingress_connection_arn, params::Dict{String,<:Any})

Return a full description of an App Runner VPC Ingress Connection resource.

Arguments

  • vpc_ingress_connection_arn: The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you want a description for.
source
Main.Apprunner.disassociate_custom_domainMethod
disassociate_custom_domain(domain_name, service_arn)
disassociate_custom_domain(domain_name, service_arn, params::Dict{String,<:Any})

Disassociate a custom domain name from an App Runner service. Certificates tracking domain validity are associated with a custom domain and are stored in AWS Certificate Manager (ACM). These certificates aren't deleted as part of this action. App Runner delays certificate deletion for 30 days after a domain is disassociated from your service.

Arguments

  • domain_name: The domain name that you want to disassociate from the App Runner service.
  • service_arn: The Amazon Resource Name (ARN) of the App Runner service that you want to disassociate a custom domain name from.
source
Main.Apprunner.list_auto_scaling_configurationsMethod
list_auto_scaling_configurations()
list_auto_scaling_configurations(params::Dict{String,<:Any})

Returns a list of active App Runner automatic scaling configurations in your Amazon Web Services account. You can query the revisions for a specific configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested name. To retrieve a full description of a particular configuration revision, call and provide one of the ARNs returned by ListAutoScalingConfigurations.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AutoScalingConfigurationName": The name of the App Runner auto scaling configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified, App Runner returns revisions of all active configurations.
  • "LatestOnly": Set to true to list only the latest revision for each requested configuration name. Set to false to list all revisions for each requested configuration name. Default: true
  • "MaxResults": The maximum number of results to include in each response (result page). It's used for a paginated request. If you don't specify MaxResults, the request retrieves all available results in a single response.
  • "NextToken": A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request. If you don't specify NextToken, the request retrieves the first result page.
source
Main.Apprunner.list_connectionsMethod
list_connections()
list_connections(params::Dict{String,<:Any})

Returns a list of App Runner connections that are associated with your Amazon Web Services account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ConnectionName": If specified, only this connection is returned. If not specified, the result isn't filtered by name.
  • "MaxResults": The maximum number of results to include in each response (result page). Used for a paginated request. If you don't specify MaxResults, the request retrieves all available results in a single response.
  • "NextToken": A token from a previous result page. Used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request. If you don't specify NextToken, the request retrieves the first result page.
source
Main.Apprunner.list_observability_configurationsMethod
list_observability_configurations()
list_observability_configurations(params::Dict{String,<:Any})

Returns a list of active App Runner observability configurations in your Amazon Web Services account. You can query the revisions for a specific configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested name. To retrieve a full description of a particular configuration revision, call and provide one of the ARNs returned by ListObservabilityConfigurations.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "LatestOnly": Set to true to list only the latest revision for each requested configuration name. Set to false to list all revisions for each requested configuration name. Default: true
  • "MaxResults": The maximum number of results to include in each response (result page). It's used for a paginated request. If you don't specify MaxResults, the request retrieves all available results in a single response.
  • "NextToken": A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request. If you don't specify NextToken, the request retrieves the first result page.
  • "ObservabilityConfigurationName": The name of the App Runner observability configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified, App Runner returns revisions of all active configurations.
source
Main.Apprunner.list_operationsMethod
list_operations(service_arn)
list_operations(service_arn, params::Dict{String,<:Any})

Return a list of operations that occurred on an App Runner service. The resulting list of OperationSummary objects is sorted in reverse chronological order. The first object on the list represents the last started operation.

Arguments

  • service_arn: The Amazon Resource Name (ARN) of the App Runner service that you want a list of operations for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to include in each response (result page). It's used for a paginated request. If you don't specify MaxResults, the request retrieves all available results in a single response.
  • "NextToken": A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request. If you don't specify NextToken, the request retrieves the first result page.
source
Main.Apprunner.list_servicesMethod
list_services()
list_services(params::Dict{String,<:Any})

Returns a list of running App Runner services in your Amazon Web Services account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to include in each response (result page). It's used for a paginated request. If you don't specify MaxResults, the request retrieves all available results in a single response.
  • "NextToken": A token from a previous result page. Used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request. If you don't specify NextToken, the request retrieves the first result page.
source
Main.Apprunner.list_services_for_auto_scaling_configurationMethod
list_services_for_auto_scaling_configuration(auto_scaling_configuration_arn)
list_services_for_auto_scaling_configuration(auto_scaling_configuration_arn, params::Dict{String,<:Any})

Returns a list of the associated App Runner services using an auto scaling configuration.

Arguments

  • auto_scaling_configuration_arn: The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want to list the services for. The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either .../name or .../name/revision . If a revision isn't specified, the latest active revision is used.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to include in each response (result page). It's used for a paginated request. If you don't specify MaxResults, the request retrieves all available results in a single response.
  • "NextToken": A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request. If you don't specify NextToken, the request retrieves the first result page.
source
Main.Apprunner.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

List tags that are associated with for an App Runner resource. The response contains a list of tag key-value pairs.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource that a tag list is requested for. It must be the ARN of an App Runner resource.
source
Main.Apprunner.list_vpc_connectorsMethod
list_vpc_connectors()
list_vpc_connectors(params::Dict{String,<:Any})

Returns a list of App Runner VPC connectors in your Amazon Web Services account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to include in each response (result page). It's used for a paginated request. If you don't specify MaxResults, the request retrieves all available results in a single response.
  • "NextToken": A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request. If you don't specify NextToken, the request retrieves the first result page.
source
Main.Apprunner.list_vpc_ingress_connectionsMethod
list_vpc_ingress_connections()
list_vpc_ingress_connections(params::Dict{String,<:Any})

Return a list of App Runner VPC Ingress Connections in your Amazon Web Services account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filter": The VPC Ingress Connections to be listed based on either the Service Arn or Vpc Endpoint Id, or both.
  • "MaxResults": The maximum number of results to include in each response (result page). It's used for a paginated request. If you don't specify MaxResults, the request retrieves all available results in a single response.
  • "NextToken": A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request. If you don't specify NextToken, the request retrieves the first result page.
source
Main.Apprunner.pause_serviceMethod
pause_service(service_arn)
pause_service(service_arn, params::Dict{String,<:Any})

Pause an active App Runner service. App Runner reduces compute capacity for the service to zero and loses state (for example, ephemeral storage is removed). This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.

Arguments

  • service_arn: The Amazon Resource Name (ARN) of the App Runner service that you want to pause.
source
Main.Apprunner.resume_serviceMethod
resume_service(service_arn)
resume_service(service_arn, params::Dict{String,<:Any})

Resume an active App Runner service. App Runner provisions compute capacity for the service. This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.

Arguments

  • service_arn: The Amazon Resource Name (ARN) of the App Runner service that you want to resume.
source
Main.Apprunner.start_deploymentMethod
start_deployment(service_arn)
start_deployment(service_arn, params::Dict{String,<:Any})

Initiate a manual deployment of the latest commit in a source code repository or the latest image in a source image repository to an App Runner service. For a source code repository, App Runner retrieves the commit and builds a Docker image. For a source image repository, App Runner retrieves the latest Docker image. In both cases, App Runner then deploys the new image to your service and starts a new container instance. This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.

Arguments

  • service_arn: The Amazon Resource Name (ARN) of the App Runner service that you want to manually deploy to.
source
Main.Apprunner.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Add tags to, or update the tag values of, an App Runner resource. A tag is a key-value pair.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource that you want to update tags for. It must be the ARN of an App Runner resource.
  • tags: A list of tag key-value pairs to add or update. If a key is new to the resource, the tag is added with the provided value. If a key is already associated with the resource, the value of the tag is updated.
source
Main.Apprunner.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Remove tags from an App Runner resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource that you want to remove tags from. It must be the ARN of an App Runner resource.
  • tag_keys: A list of tag keys that you want to remove.
source
Main.Apprunner.update_default_auto_scaling_configurationMethod
update_default_auto_scaling_configuration(auto_scaling_configuration_arn)
update_default_auto_scaling_configuration(auto_scaling_configuration_arn, params::Dict{String,<:Any})

Update an auto scaling configuration to be the default. The existing default auto scaling configuration will be set to non-default automatically.

Arguments

  • auto_scaling_configuration_arn: The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want to set as the default. The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either .../name or .../name/revision . If a revision isn't specified, the latest active revision is set as the default.
source
Main.Apprunner.update_serviceMethod
update_service(service_arn)
update_service(service_arn, params::Dict{String,<:Any})

Update an App Runner service. You can update the source configuration and instance configuration of the service. You can also update the ARN of the auto scaling configuration resource that's associated with the service. However, you can't change the name or the encryption configuration of the service. These can be set only when you create the service. To update the tags applied to your service, use the separate actions TagResource and UntagResource. This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.

Arguments

  • service_arn: The Amazon Resource Name (ARN) of the App Runner service that you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AutoScalingConfigurationArn": The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with the App Runner service.
  • "HealthCheckConfiguration": The settings for the health check that App Runner performs to monitor the health of the App Runner service.
  • "InstanceConfiguration": The runtime configuration to apply to instances (scaling units) of your service.
  • "NetworkConfiguration": Configuration settings related to network traffic of the web application that the App Runner service runs.
  • "ObservabilityConfiguration": The observability configuration of your service.
  • "SourceConfiguration": The source configuration to apply to the App Runner service. You can change the configuration of the code or image repository that the service uses. However, you can't switch from code to image or the other way around. This means that you must provide the same structure member of SourceConfiguration that you originally included when you created the service. Specifically, you can include either CodeRepository or ImageRepository. To update the source configuration, set the values to members of the structure that you include.
source
Main.Apprunner.update_vpc_ingress_connectionMethod
update_vpc_ingress_connection(ingress_vpc_configuration, vpc_ingress_connection_arn)
update_vpc_ingress_connection(ingress_vpc_configuration, vpc_ingress_connection_arn, params::Dict{String,<:Any})

Update an existing App Runner VPC Ingress Connection resource. The VPC Ingress Connection must be in one of the following states to be updated: AVAILABLE FAILEDCREATION FAILEDUPDATE

Arguments

  • ingress_vpc_configuration: Specifications for the customer’s Amazon VPC and the related Amazon Web Services PrivateLink VPC endpoint that are used to update the VPC Ingress Connection resource.
  • vpc_ingress_connection_arn: The Amazon Resource Name (Arn) for the App Runner VPC Ingress Connection resource that you want to update.
source