You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.AppRunner

Inherits:
AWS.Service show all
Identifier:
apprunner
API Version:
2020-05-15
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

AWS App Runner is an application service that provides a fast, simple, and cost-effective way to go directly from an existing container image or source code to a running service in the AWS cloud in seconds. You don't need to learn new technologies, decide which compute service to use, or understand how to provision and configure AWS resources.

App Runner connects directly to your container registry or source code repository. It provides an automatic delivery pipeline with fully managed operations, high performance, scalability, and security.

For more information about App Runner, see the AWS App Runner Developer Guide. For release information, see the AWS App Runner Release Notes.

To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that you can use to access the API, see Tools for Amazon Web Services.

Endpoints

For a list of Region-specific endpoints that App Runner supports, see AWS App Runner endpoints and quotas in the AWS General Reference.

Sending a Request Using AppRunner

var apprunner = new AWS.AppRunner();
apprunner.associateCustomDomain(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the AppRunner object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var apprunner = new AWS.AppRunner({apiVersion: '2020-05-15'});

You can also set the API version globally in AWS.config.apiVersions using the apprunner service identifier:

AWS.config.apiVersions = {
  apprunner: '2020-05-15',
  // other service API versions
};

var apprunner = new AWS.AppRunner();

Version:

  • 2020-05-15

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.AppRunner(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a AppRunner object

var apprunner = new AWS.AppRunner({apiVersion: '2020-05-15'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.AppRunner.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.AppRunner.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.AppRunner.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

associateCustomDomain(params = {}, callback) ⇒ AWS.Request

Associate your own domain name with the AWS 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).

Service Reference:

Examples:

Calling the associateCustomDomain operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  ServiceArn: 'STRING_VALUE', /* required */
  EnableWWWSubdomain: true || false
};
apprunner.associateCustomDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ServiceArn — (String)

      The Amazon Resource Name (ARN) of the App Runner service that you want to associate a custom domain name with.

    • DomainName — (String)

      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).

    • EnableWWWSubdomain — (Boolean)

      Set to true to associate the subdomain www.DomainName with the App Runner service in addition to the base domain.

      Default: true

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DNSTarget — (String)

        The App Runner subdomain of the App Runner service. The custom domain name is mapped to this target name.

      • ServiceArn — (String)

        The Amazon Resource Name (ARN) of the App Runner service with which a custom domain name is associated.

      • CustomDomain — (map)

        A description of the domain name that's being associated.

        • DomainNamerequired — (String)

          An associated custom domain endpoint. It can be 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).

        • EnableWWWSubdomainrequired — (Boolean)

          When true, the subdomain www.DomainName is associated with the App Runner service in addition to the base domain.

        • CertificateValidationRecords — (Array<map>)

          A list of certificate CNAME records that's used for this domain name.

          • Name — (String)

            The certificate CNAME record name.

          • Type — (String)

            The record type, always CNAME.

          • Value — (String)

            The certificate CNAME record value.

          • Status — (String)

            The current state of the certificate CNAME record validation. It should change to SUCCESS after App Runner completes validation with your DNS.

            Possible values include:
            • "PENDING_VALIDATION"
            • "SUCCESS"
            • "FAILED"
        • Statusrequired — (String)

          The current state of the domain name association.

          Possible values include:
          • "CREATING"
          • "CREATE_FAILED"
          • "ACTIVE"
          • "DELETING"
          • "DELETE_FAILED"
          • "PENDING_CERTIFICATE_DNS_VALIDATION"
          • "BINDING_CERTIFICATE"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createAutoScalingConfiguration(params = {}, callback) ⇒ AWS.Request

Create an AWS App Runner automatic scaling configuration resource. App Runner requires this resource when you create App Runner services that require non-default auto scaling settings. You can share an auto scaling configuration across multiple services.

Create multiple revisions of a configuration by using the same AutoScalingConfigurationName and different AutoScalingConfigurationRevision values. When you create a service, you can set it to use the latest active revision of an auto scaling configuration or a specific revision.

Configure a higher MinSize to increase the spread of your App Runner service over more Availability Zones in the AWS Region. The tradeoff is a higher minimal cost.

Configure a lower MaxSize to control your cost. The tradeoff is lower responsiveness during peak demand.

Service Reference:

Examples:

Calling the createAutoScalingConfiguration operation

var params = {
  AutoScalingConfigurationName: 'STRING_VALUE', /* required */
  MaxConcurrency: 'NUMBER_VALUE',
  MaxSize: 'NUMBER_VALUE',
  MinSize: 'NUMBER_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
apprunner.createAutoScalingConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AutoScalingConfigurationName — (String)

      A name for the auto scaling configuration. When you use it for the first time in an AWS 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.

    • MaxConcurrency — (Integer)

      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

    • MinSize — (Integer)

      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

    • MaxSize — (Integer)

      The maximum number of instances that your service scales up to. At most MaxSize instances actively serve traffic for your service.

      Default: 25

    • Tags — (Array<map>)

      A list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair.

      • Key — (String)

        The key of the tag.

      • Value — (String)

        The value of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AutoScalingConfiguration — (map)

        A description of the App Runner auto scaling configuration that's created by this request.

        • AutoScalingConfigurationArn — (String)

          The Amazon Resource Name (ARN) of this auto scaling configuration.

        • AutoScalingConfigurationName — (String)

          The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.

        • AutoScalingConfigurationRevision — (Integer)

          The revision of this auto scaling configuration. It's unique among all the active configurations ("Status": "ACTIVE") that share the same AutoScalingConfigurationName.

        • Latest — (Boolean)

          It's set to true for the configuration with the highest Revision among all configurations that share the same Name. It's set to false otherwise.

        • Status — (String)

          The current state of the auto scaling configuration. If the status of a configuration revision is INACTIVE, it was deleted and can't be used. Inactive configuration revisions are permanently removed some time after they are deleted.

          Possible values include:
          • "ACTIVE"
          • "INACTIVE"
        • MaxConcurrency — (Integer)

          The maximum number of concurrent requests that an instance processes. If the number of concurrent requests exceeds this limit, App Runner scales the service up.

        • MinSize — (Integer)

          The minimum number of instances that App Runner provisions for a 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.

        • MaxSize — (Integer)

          The maximum number of instances that a service scales up to. At most MaxSize instances actively serve traffic for your service.

        • CreatedAt — (Date)

          The time when the auto scaling configuration was created. It's in Unix time stamp format.

        • DeletedAt — (Date)

          The time when the auto scaling configuration was deleted. It's in Unix time stamp format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createConnection(params = {}, callback) ⇒ AWS.Request

Create an AWS 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 repositories. GitHub requires a user interface approval process through the App Runner console before you can use the connection.

Service Reference:

Examples:

Calling the createConnection operation

var params = {
  ConnectionName: 'STRING_VALUE', /* required */
  ProviderType: GITHUB, /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
apprunner.createConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConnectionName — (String)

      A name for the new connection. It must be unique across all App Runner connections for the AWS account in the AWS Region.

    • ProviderType — (String)

      The source repository provider.

      Possible values include:
      • "GITHUB"
    • Tags — (Array<map>)

      A list of metadata items that you can associate with your connection resource. A tag is a key-value pair.

      • Key — (String)

        The key of the tag.

      • Value — (String)

        The value of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Connection — (map)

        A description of the App Runner connection that's created by this request.

        • ConnectionName — (String)

          The customer-provided connection name.

        • ConnectionArn — (String)

          The Amazon Resource Name (ARN) of this connection.

        • ProviderType — (String)

          The source repository provider.

          Possible values include:
          • "GITHUB"
        • Status — (String)

          The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an App Runner service.

          Possible values include:
          • "PENDING_HANDSHAKE"
          • "AVAILABLE"
          • "ERROR"
          • "DELETED"
        • CreatedAt — (Date)

          The App Runner connection creation time, expressed as a Unix time stamp.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createService(params = {}, callback) ⇒ AWS.Request

Create an AWS 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.

Service Reference:

Examples:

Calling the createService operation

var params = {
  ServiceName: 'STRING_VALUE', /* required */
  SourceConfiguration: { /* required */
    AuthenticationConfiguration: {
      AccessRoleArn: 'STRING_VALUE',
      ConnectionArn: 'STRING_VALUE'
    },
    AutoDeploymentsEnabled: true || false,
    CodeRepository: {
      RepositoryUrl: 'STRING_VALUE', /* required */
      SourceCodeVersion: { /* required */
        Type: BRANCH, /* required */
        Value: 'STRING_VALUE' /* required */
      },
      CodeConfiguration: {
        ConfigurationSource: REPOSITORY | API, /* required */
        CodeConfigurationValues: {
          Runtime: PYTHON_3 | NODEJS_12, /* required */
          BuildCommand: 'STRING_VALUE',
          Port: 'STRING_VALUE',
          RuntimeEnvironmentVariables: {
            '<RuntimeEnvironmentVariablesKey>': 'STRING_VALUE',
            /* '<RuntimeEnvironmentVariablesKey>': ... */
          },
          StartCommand: 'STRING_VALUE'
        }
      }
    },
    ImageRepository: {
      ImageIdentifier: 'STRING_VALUE', /* required */
      ImageRepositoryType: ECR | ECR_PUBLIC, /* required */
      ImageConfiguration: {
        Port: 'STRING_VALUE',
        RuntimeEnvironmentVariables: {
          '<RuntimeEnvironmentVariablesKey>': 'STRING_VALUE',
          /* '<RuntimeEnvironmentVariablesKey>': ... */
        },
        StartCommand: 'STRING_VALUE'
      }
    }
  },
  AutoScalingConfigurationArn: 'STRING_VALUE',
  EncryptionConfiguration: {
    KmsKey: 'STRING_VALUE' /* required */
  },
  HealthCheckConfiguration: {
    HealthyThreshold: 'NUMBER_VALUE',
    Interval: 'NUMBER_VALUE',
    Path: 'STRING_VALUE',
    Protocol: TCP | HTTP,
    Timeout: 'NUMBER_VALUE',
    UnhealthyThreshold: 'NUMBER_VALUE'
  },
  InstanceConfiguration: {
    Cpu: 'STRING_VALUE',
    InstanceRoleArn: 'STRING_VALUE',
    Memory: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
apprunner.createService(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ServiceName — (String)

      A name for the new service. It must be unique across all the running App Runner services in your AWS account in the AWS Region.

    • SourceConfiguration — (map)

      The source to deploy to the App Runner service. It can be a code or an image repository.

      • CodeRepository — (map)

        The description of a source code repository.

        You must provide either this member or ImageRepository (but not both).

        • RepositoryUrlrequired — (String)

          The location of the repository that contains the source code.

        • SourceCodeVersionrequired — (map)

          The version that should be used within the source code repository.

          • Typerequired — (String)

            The type of version identifier.

            For a git-based repository, branches represent versions.

            Possible values include:
            • "BRANCH"
          • Valuerequired — (String)

            A source code version.

            For a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to the branch.

        • CodeConfiguration — (map)

          Configuration for building and running the service from a source code repository.

          • ConfigurationSourcerequired — (String)

            The source of the App Runner configuration. Values are interpreted as follows:

            • REPOSITORY – App Runner reads configuration values from the apprunner.yaml file in the source code repository and ignores CodeConfigurationValues.

            • API – App Runner uses configuration values provided in CodeConfigurationValues and ignores the apprunner.yaml file in the source code repository.

            Possible values include:
            • "REPOSITORY"
            • "API"
          • CodeConfigurationValues — (map)

            The basic configuration for building and running the App Runner service. Use it to quickly launch an App Runner service without providing a apprunner.yaml file in the source code repository (or ignoring the file if it exists).

            • Runtimerequired — (String)

              A runtime environment type for building and running an App Runner service. It represents a programming language runtime.

              Possible values include:
              • "PYTHON_3"
              • "NODEJS_12"
            • BuildCommand — (String)

              The command App Runner runs to build your application.

            • StartCommand — (String)

              The command App Runner runs to start your application.

            • Port — (String)

              The port that your application listens to in the container.

              Default: 8080

            • RuntimeEnvironmentVariables — (map<String>)

              The environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

      • ImageRepository — (map)

        The description of a source image repository.

        You must provide either this member or CodeRepository (but not both).

        • ImageIdentifierrequired — (String)

          The identifier of an image.

          For an image in Amazon Elastic Container Registry (Amazon ECR), this is an image name. For the image name format, see Pulling an image in the Amazon ECR User Guide.

        • ImageConfiguration — (map)

          Configuration for running the identified image.

          • RuntimeEnvironmentVariables — (map<String>)

            Environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

          • StartCommand — (String)

            An optional command that App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.

          • Port — (String)

            The port that your application listens to in the container.

            Default: 8080

        • ImageRepositoryTyperequired — (String)

          The type of the image repository. This reflects the repository provider and whether the repository is private or public.

          Possible values include:
          • "ECR"
          • "ECR_PUBLIC"
      • AutoDeploymentsEnabled — (Boolean)

        If true, continuous integration from the source repository is enabled for the App Runner service. Each repository change (source code commit or new image version) starts a deployment.

        Default: true

      • AuthenticationConfiguration — (map)

        Describes the resources that are needed to authenticate access to some source repositories.

        • ConnectionArn — (String)

          The Amazon Resource Name (ARN) of the App Runner connection that enables the App Runner service to connect to a source repository. It's required for GitHub code repositories.

        • AccessRoleArn — (String)

          The Amazon Resource Name (ARN) of the IAM role that grants the App Runner service access to a source repository. It's required for ECR image repositories (but not for ECR Public repositories).

    • InstanceConfiguration — (map)

      The runtime configuration of instances (scaling units) of the App Runner service.

      • Cpu — (String)

        The number of CPU units reserved for each instance of your App Runner service.

        Default: 1 vCPU

      • Memory — (String)

        The amount of memory, in MB or GB, reserved for each instance of your App Runner service.

        Default: 2 GB

      • InstanceRoleArn — (String)

        The Amazon Resource Name (ARN) of an IAM role that provides permissions to your App Runner service. These are permissions that your code needs when it calls any AWS APIs.

    • Tags — (Array<map>)

      An optional list of metadata items that you can associate with your service resource. A tag is a key-value pair.

      • Key — (String)

        The key of the tag.

      • Value — (String)

        The value of the tag.

    • EncryptionConfiguration — (map)

      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 AWS managed CMK.

      • KmsKeyrequired — (String)

        The ARN of the KMS key that's used for encryption.

    • HealthCheckConfiguration — (map)

      The settings for the health check that AWS App Runner performs to monitor the health of your service.

      • Protocol — (String)

        The IP protocol that App Runner uses to perform health checks for your service.

        If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.

        Default: TCP

        Possible values include:
        • "TCP"
        • "HTTP"
      • Path — (String)

        The URL that health check requests are sent to.

        Path is only applicable when you set Protocol to HTTP.

        Default: "/"

      • Interval — (Integer)

        The time interval, in seconds, between health checks.

        Default: 5

      • Timeout — (Integer)

        The time, in seconds, to wait for a health check response before deciding it failed.

        Default: 2

      • HealthyThreshold — (Integer)

        The number of consecutive checks that must succeed before App Runner decides that the service is healthy.

        Default: 3

      • UnhealthyThreshold — (Integer)

        The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

        Default: 3

    • AutoScalingConfigurationArn — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Service — (map)

        A description of the App Runner service that's created by this request.

        • ServiceNamerequired — (String)

          The customer-provided service name.

        • ServiceIdrequired — (String)

          An ID that App Runner generated for this service. It's unique within the AWS Region.

        • ServiceArnrequired — (String)

          The Amazon Resource Name (ARN) of this service.

        • ServiceUrlrequired — (String)

          A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.

        • CreatedAtrequired — (Date)

          The time when the App Runner service was created. It's in the Unix time stamp format.

        • UpdatedAtrequired — (Date)

          The time when the App Runner service was last updated at. It's in the Unix time stamp format.

        • DeletedAt — (Date)

          The time when the App Runner service was deleted. It's in the Unix time stamp format.

        • Statusrequired — (String)

          The current state of the App Runner service. These particular values mean the following.

          • CREATE_FAILED – The service failed to create. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and retry the call to create the service.

            The failed service isn't usable, and still counts towards your service quota. When you're done analyzing the failure, delete the service.

          • DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.

          Possible values include:
          • "CREATE_FAILED"
          • "RUNNING"
          • "DELETED"
          • "DELETE_FAILED"
          • "PAUSED"
          • "OPERATION_IN_PROGRESS"
        • SourceConfigurationrequired — (map)

          The source deployed to the App Runner service. It can be a code or an image repository.

          • CodeRepository — (map)

            The description of a source code repository.

            You must provide either this member or ImageRepository (but not both).

            • RepositoryUrlrequired — (String)

              The location of the repository that contains the source code.

            • SourceCodeVersionrequired — (map)

              The version that should be used within the source code repository.

              • Typerequired — (String)

                The type of version identifier.

                For a git-based repository, branches represent versions.

                Possible values include:
                • "BRANCH"
              • Valuerequired — (String)

                A source code version.

                For a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to the branch.

            • CodeConfiguration — (map)

              Configuration for building and running the service from a source code repository.

              • ConfigurationSourcerequired — (String)

                The source of the App Runner configuration. Values are interpreted as follows:

                • REPOSITORY – App Runner reads configuration values from the apprunner.yaml file in the source code repository and ignores CodeConfigurationValues.

                • API – App Runner uses configuration values provided in CodeConfigurationValues and ignores the apprunner.yaml file in the source code repository.

                Possible values include:
                • "REPOSITORY"
                • "API"
              • CodeConfigurationValues — (map)

                The basic configuration for building and running the App Runner service. Use it to quickly launch an App Runner service without providing a apprunner.yaml file in the source code repository (or ignoring the file if it exists).

                • Runtimerequired — (String)

                  A runtime environment type for building and running an App Runner service. It represents a programming language runtime.

                  Possible values include:
                  • "PYTHON_3"
                  • "NODEJS_12"
                • BuildCommand — (String)

                  The command App Runner runs to build your application.

                • StartCommand — (String)

                  The command App Runner runs to start your application.

                • Port — (String)

                  The port that your application listens to in the container.

                  Default: 8080

                • RuntimeEnvironmentVariables — (map<String>)

                  The environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

          • ImageRepository — (map)

            The description of a source image repository.

            You must provide either this member or CodeRepository (but not both).

            • ImageIdentifierrequired — (String)

              The identifier of an image.

              For an image in Amazon Elastic Container Registry (Amazon ECR), this is an image name. For the image name format, see Pulling an image in the Amazon ECR User Guide.

            • ImageConfiguration — (map)

              Configuration for running the identified image.

              • RuntimeEnvironmentVariables — (map<String>)

                Environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

              • StartCommand — (String)

                An optional command that App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.

              • Port — (String)

                The port that your application listens to in the container.

                Default: 8080

            • ImageRepositoryTyperequired — (String)

              The type of the image repository. This reflects the repository provider and whether the repository is private or public.

              Possible values include:
              • "ECR"
              • "ECR_PUBLIC"
          • AutoDeploymentsEnabled — (Boolean)

            If true, continuous integration from the source repository is enabled for the App Runner service. Each repository change (source code commit or new image version) starts a deployment.

            Default: true

          • AuthenticationConfiguration — (map)

            Describes the resources that are needed to authenticate access to some source repositories.

            • ConnectionArn — (String)

              The Amazon Resource Name (ARN) of the App Runner connection that enables the App Runner service to connect to a source repository. It's required for GitHub code repositories.

            • AccessRoleArn — (String)

              The Amazon Resource Name (ARN) of the IAM role that grants the App Runner service access to a source repository. It's required for ECR image repositories (but not for ECR Public repositories).

        • InstanceConfigurationrequired — (map)

          The runtime configuration of instances (scaling units) of this service.

          • Cpu — (String)

            The number of CPU units reserved for each instance of your App Runner service.

            Default: 1 vCPU

          • Memory — (String)

            The amount of memory, in MB or GB, reserved for each instance of your App Runner service.

            Default: 2 GB

          • InstanceRoleArn — (String)

            The Amazon Resource Name (ARN) of an IAM role that provides permissions to your App Runner service. These are permissions that your code needs when it calls any AWS APIs.

        • EncryptionConfiguration — (map)

          The encryption key that App Runner uses to encrypt the service logs and the copy of the source repository that App Runner maintains for the service. It can be either a customer-provided encryption key or an AWS managed CMK.

          • KmsKeyrequired — (String)

            The ARN of the KMS key that's used for encryption.

        • HealthCheckConfiguration — (map)

          The settings for the health check that App Runner performs to monitor the health of this service.

          • Protocol — (String)

            The IP protocol that App Runner uses to perform health checks for your service.

            If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.

            Default: TCP

            Possible values include:
            • "TCP"
            • "HTTP"
          • Path — (String)

            The URL that health check requests are sent to.

            Path is only applicable when you set Protocol to HTTP.

            Default: "/"

          • Interval — (Integer)

            The time interval, in seconds, between health checks.

            Default: 5

          • Timeout — (Integer)

            The time, in seconds, to wait for a health check response before deciding it failed.

            Default: 2

          • HealthyThreshold — (Integer)

            The number of consecutive checks that must succeed before App Runner decides that the service is healthy.

            Default: 3

          • UnhealthyThreshold — (Integer)

            The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

            Default: 3

        • AutoScalingConfigurationSummaryrequired — (map)

          Summary information for the App Runner automatic scaling configuration resource that's associated with this service.

          • AutoScalingConfigurationArn — (String)

            The Amazon Resource Name (ARN) of this auto scaling configuration.

          • AutoScalingConfigurationName — (String)

            The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.

          • AutoScalingConfigurationRevision — (Integer)

            The revision of this auto scaling configuration. It's unique among all the active configurations ("Status": "ACTIVE") with the same AutoScalingConfigurationName.

      • OperationId — (String)

        The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track the operation's progress.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteAutoScalingConfiguration(params = {}, callback) ⇒ AWS.Request

Delete an AWS App Runner automatic scaling 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.

Service Reference:

Examples:

Calling the deleteAutoScalingConfiguration operation

var params = {
  AutoScalingConfigurationArn: 'STRING_VALUE' /* required */
};
apprunner.deleteAutoScalingConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AutoScalingConfigurationArn — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AutoScalingConfiguration — (map)

        A description of the App Runner auto scaling configuration that this request just deleted.

        • AutoScalingConfigurationArn — (String)

          The Amazon Resource Name (ARN) of this auto scaling configuration.

        • AutoScalingConfigurationName — (String)

          The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.

        • AutoScalingConfigurationRevision — (Integer)

          The revision of this auto scaling configuration. It's unique among all the active configurations ("Status": "ACTIVE") that share the same AutoScalingConfigurationName.

        • Latest — (Boolean)

          It's set to true for the configuration with the highest Revision among all configurations that share the same Name. It's set to false otherwise.

        • Status — (String)

          The current state of the auto scaling configuration. If the status of a configuration revision is INACTIVE, it was deleted and can't be used. Inactive configuration revisions are permanently removed some time after they are deleted.

          Possible values include:
          • "ACTIVE"
          • "INACTIVE"
        • MaxConcurrency — (Integer)

          The maximum number of concurrent requests that an instance processes. If the number of concurrent requests exceeds this limit, App Runner scales the service up.

        • MinSize — (Integer)

          The minimum number of instances that App Runner provisions for a 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.

        • MaxSize — (Integer)

          The maximum number of instances that a service scales up to. At most MaxSize instances actively serve traffic for your service.

        • CreatedAt — (Date)

          The time when the auto scaling configuration was created. It's in Unix time stamp format.

        • DeletedAt — (Date)

          The time when the auto scaling configuration was deleted. It's in Unix time stamp format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteConnection(params = {}, callback) ⇒ AWS.Request

Delete an AWS 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.

Service Reference:

Examples:

Calling the deleteConnection operation

var params = {
  ConnectionArn: 'STRING_VALUE' /* required */
};
apprunner.deleteConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConnectionArn — (String)

      The Amazon Resource Name (ARN) of the App Runner connection that you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Connection — (map)

        A description of the App Runner connection that this request just deleted.

        • ConnectionName — (String)

          The customer-provided connection name.

        • ConnectionArn — (String)

          The Amazon Resource Name (ARN) of this connection.

        • ProviderType — (String)

          The source repository provider.

          Possible values include:
          • "GITHUB"
        • Status — (String)

          The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an App Runner service.

          Possible values include:
          • "PENDING_HANDSHAKE"
          • "AVAILABLE"
          • "ERROR"
          • "DELETED"
        • CreatedAt — (Date)

          The App Runner connection creation time, expressed as a Unix time stamp.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteService(params = {}, callback) ⇒ AWS.Request

Delete an AWS 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.

Service Reference:

Examples:

Calling the deleteService operation

var params = {
  ServiceArn: 'STRING_VALUE' /* required */
};
apprunner.deleteService(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ServiceArn — (String)

      The Amazon Resource Name (ARN) of the App Runner service that you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Service — (map)

        A description of the App Runner service that this request just deleted.

        • ServiceNamerequired — (String)

          The customer-provided service name.

        • ServiceIdrequired — (String)

          An ID that App Runner generated for this service. It's unique within the AWS Region.

        • ServiceArnrequired — (String)

          The Amazon Resource Name (ARN) of this service.

        • ServiceUrlrequired — (String)

          A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.

        • CreatedAtrequired — (Date)

          The time when the App Runner service was created. It's in the Unix time stamp format.

        • UpdatedAtrequired — (Date)

          The time when the App Runner service was last updated at. It's in the Unix time stamp format.

        • DeletedAt — (Date)

          The time when the App Runner service was deleted. It's in the Unix time stamp format.

        • Statusrequired — (String)

          The current state of the App Runner service. These particular values mean the following.

          • CREATE_FAILED – The service failed to create. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and retry the call to create the service.

            The failed service isn't usable, and still counts towards your service quota. When you're done analyzing the failure, delete the service.

          • DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.

          Possible values include:
          • "CREATE_FAILED"
          • "RUNNING"
          • "DELETED"
          • "DELETE_FAILED"
          • "PAUSED"
          • "OPERATION_IN_PROGRESS"
        • SourceConfigurationrequired — (map)

          The source deployed to the App Runner service. It can be a code or an image repository.

          • CodeRepository — (map)

            The description of a source code repository.

            You must provide either this member or ImageRepository (but not both).

            • RepositoryUrlrequired — (String)

              The location of the repository that contains the source code.

            • SourceCodeVersionrequired — (map)

              The version that should be used within the source code repository.

              • Typerequired — (String)

                The type of version identifier.

                For a git-based repository, branches represent versions.

                Possible values include:
                • "BRANCH"
              • Valuerequired — (String)

                A source code version.

                For a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to the branch.

            • CodeConfiguration — (map)

              Configuration for building and running the service from a source code repository.

              • ConfigurationSourcerequired — (String)

                The source of the App Runner configuration. Values are interpreted as follows:

                • REPOSITORY – App Runner reads configuration values from the apprunner.yaml file in the source code repository and ignores CodeConfigurationValues.

                • API – App Runner uses configuration values provided in CodeConfigurationValues and ignores the apprunner.yaml file in the source code repository.

                Possible values include:
                • "REPOSITORY"
                • "API"
              • CodeConfigurationValues — (map)

                The basic configuration for building and running the App Runner service. Use it to quickly launch an App Runner service without providing a apprunner.yaml file in the source code repository (or ignoring the file if it exists).

                • Runtimerequired — (String)

                  A runtime environment type for building and running an App Runner service. It represents a programming language runtime.

                  Possible values include:
                  • "PYTHON_3"
                  • "NODEJS_12"
                • BuildCommand — (String)

                  The command App Runner runs to build your application.

                • StartCommand — (String)

                  The command App Runner runs to start your application.

                • Port — (String)

                  The port that your application listens to in the container.

                  Default: 8080

                • RuntimeEnvironmentVariables — (map<String>)

                  The environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

          • ImageRepository — (map)

            The description of a source image repository.

            You must provide either this member or CodeRepository (but not both).

            • ImageIdentifierrequired — (String)

              The identifier of an image.

              For an image in Amazon Elastic Container Registry (Amazon ECR), this is an image name. For the image name format, see Pulling an image in the Amazon ECR User Guide.

            • ImageConfiguration — (map)

              Configuration for running the identified image.

              • RuntimeEnvironmentVariables — (map<String>)

                Environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

              • StartCommand — (String)

                An optional command that App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.

              • Port — (String)

                The port that your application listens to in the container.

                Default: 8080

            • ImageRepositoryTyperequired — (String)

              The type of the image repository. This reflects the repository provider and whether the repository is private or public.

              Possible values include:
              • "ECR"
              • "ECR_PUBLIC"
          • AutoDeploymentsEnabled — (Boolean)

            If true, continuous integration from the source repository is enabled for the App Runner service. Each repository change (source code commit or new image version) starts a deployment.

            Default: true

          • AuthenticationConfiguration — (map)

            Describes the resources that are needed to authenticate access to some source repositories.

            • ConnectionArn — (String)

              The Amazon Resource Name (ARN) of the App Runner connection that enables the App Runner service to connect to a source repository. It's required for GitHub code repositories.

            • AccessRoleArn — (String)

              The Amazon Resource Name (ARN) of the IAM role that grants the App Runner service access to a source repository. It's required for ECR image repositories (but not for ECR Public repositories).

        • InstanceConfigurationrequired — (map)

          The runtime configuration of instances (scaling units) of this service.

          • Cpu — (String)

            The number of CPU units reserved for each instance of your App Runner service.

            Default: 1 vCPU

          • Memory — (String)

            The amount of memory, in MB or GB, reserved for each instance of your App Runner service.

            Default: 2 GB

          • InstanceRoleArn — (String)

            The Amazon Resource Name (ARN) of an IAM role that provides permissions to your App Runner service. These are permissions that your code needs when it calls any AWS APIs.

        • EncryptionConfiguration — (map)

          The encryption key that App Runner uses to encrypt the service logs and the copy of the source repository that App Runner maintains for the service. It can be either a customer-provided encryption key or an AWS managed CMK.

          • KmsKeyrequired — (String)

            The ARN of the KMS key that's used for encryption.

        • HealthCheckConfiguration — (map)

          The settings for the health check that App Runner performs to monitor the health of this service.

          • Protocol — (String)

            The IP protocol that App Runner uses to perform health checks for your service.

            If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.

            Default: TCP

            Possible values include:
            • "TCP"
            • "HTTP"
          • Path — (String)

            The URL that health check requests are sent to.

            Path is only applicable when you set Protocol to HTTP.

            Default: "/"

          • Interval — (Integer)

            The time interval, in seconds, between health checks.

            Default: 5

          • Timeout — (Integer)

            The time, in seconds, to wait for a health check response before deciding it failed.

            Default: 2

          • HealthyThreshold — (Integer)

            The number of consecutive checks that must succeed before App Runner decides that the service is healthy.

            Default: 3

          • UnhealthyThreshold — (Integer)

            The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

            Default: 3

        • AutoScalingConfigurationSummaryrequired — (map)

          Summary information for the App Runner automatic scaling configuration resource that's associated with this service.

          • AutoScalingConfigurationArn — (String)

            The Amazon Resource Name (ARN) of this auto scaling configuration.

          • AutoScalingConfigurationName — (String)

            The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.

          • AutoScalingConfigurationRevision — (Integer)

            The revision of this auto scaling configuration. It's unique among all the active configurations ("Status": "ACTIVE") with the same AutoScalingConfigurationName.

      • OperationId — (String)

        The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track the operation's progress.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeAutoScalingConfiguration(params = {}, callback) ⇒ AWS.Request

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

Examples:

Calling the describeAutoScalingConfiguration operation

var params = {
  AutoScalingConfigurationArn: 'STRING_VALUE' /* required */
};
apprunner.describeAutoScalingConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AutoScalingConfigurationArn — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AutoScalingConfiguration — (map)

        A full description of the App Runner auto scaling configuration that you specified in this request.

        • AutoScalingConfigurationArn — (String)

          The Amazon Resource Name (ARN) of this auto scaling configuration.

        • AutoScalingConfigurationName — (String)

          The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.

        • AutoScalingConfigurationRevision — (Integer)

          The revision of this auto scaling configuration. It's unique among all the active configurations ("Status": "ACTIVE") that share the same AutoScalingConfigurationName.

        • Latest — (Boolean)

          It's set to true for the configuration with the highest Revision among all configurations that share the same Name. It's set to false otherwise.

        • Status — (String)

          The current state of the auto scaling configuration. If the status of a configuration revision is INACTIVE, it was deleted and can't be used. Inactive configuration revisions are permanently removed some time after they are deleted.

          Possible values include:
          • "ACTIVE"
          • "INACTIVE"
        • MaxConcurrency — (Integer)

          The maximum number of concurrent requests that an instance processes. If the number of concurrent requests exceeds this limit, App Runner scales the service up.

        • MinSize — (Integer)

          The minimum number of instances that App Runner provisions for a 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.

        • MaxSize — (Integer)

          The maximum number of instances that a service scales up to. At most MaxSize instances actively serve traffic for your service.

        • CreatedAt — (Date)

          The time when the auto scaling configuration was created. It's in Unix time stamp format.

        • DeletedAt — (Date)

          The time when the auto scaling configuration was deleted. It's in Unix time stamp format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeCustomDomains(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the describeCustomDomains operation

var params = {
  ServiceArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
apprunner.describeCustomDomains(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ServiceArn — (String)

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

    • NextToken — (String)

      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.

    • MaxResults — (Integer)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DNSTarget — (String)

        The App Runner subdomain of the App Runner service. The associated custom domain names are mapped to this target name.

      • ServiceArn — (String)

        The Amazon Resource Name (ARN) of the App Runner service whose associated custom domain names you want to describe.

      • CustomDomains — (Array<map>)

        A list of descriptions of custom domain names that are associated with the service. In a paginated request, the request returns up to MaxResults records per call.

        • DomainNamerequired — (String)

          An associated custom domain endpoint. It can be 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).

        • EnableWWWSubdomainrequired — (Boolean)

          When true, the subdomain www.DomainName is associated with the App Runner service in addition to the base domain.

        • CertificateValidationRecords — (Array<map>)

          A list of certificate CNAME records that's used for this domain name.

          • Name — (String)

            The certificate CNAME record name.

          • Type — (String)

            The record type, always CNAME.

          • Value — (String)

            The certificate CNAME record value.

          • Status — (String)

            The current state of the certificate CNAME record validation. It should change to SUCCESS after App Runner completes validation with your DNS.

            Possible values include:
            • "PENDING_VALIDATION"
            • "SUCCESS"
            • "FAILED"
        • Statusrequired — (String)

          The current state of the domain name association.

          Possible values include:
          • "CREATING"
          • "CREATE_FAILED"
          • "ACTIVE"
          • "DELETING"
          • "DELETE_FAILED"
          • "PENDING_CERTIFICATE_DNS_VALIDATION"
          • "BINDING_CERTIFICATE"
      • NextToken — (String)

        The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeService(params = {}, callback) ⇒ AWS.Request

Return a full description of an AWS App Runner service.

Service Reference:

Examples:

Calling the describeService operation

var params = {
  ServiceArn: 'STRING_VALUE' /* required */
};
apprunner.describeService(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ServiceArn — (String)

      The Amazon Resource Name (ARN) of the App Runner service that you want a description for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Service — (map)

        A full description of the App Runner service that you specified in this request.

        • ServiceNamerequired — (String)

          The customer-provided service name.

        • ServiceIdrequired — (String)

          An ID that App Runner generated for this service. It's unique within the AWS Region.

        • ServiceArnrequired — (String)

          The Amazon Resource Name (ARN) of this service.

        • ServiceUrlrequired — (String)

          A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.

        • CreatedAtrequired — (Date)

          The time when the App Runner service was created. It's in the Unix time stamp format.

        • UpdatedAtrequired — (Date)

          The time when the App Runner service was last updated at. It's in the Unix time stamp format.

        • DeletedAt — (Date)

          The time when the App Runner service was deleted. It's in the Unix time stamp format.

        • Statusrequired — (String)

          The current state of the App Runner service. These particular values mean the following.

          • CREATE_FAILED – The service failed to create. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and retry the call to create the service.

            The failed service isn't usable, and still counts towards your service quota. When you're done analyzing the failure, delete the service.

          • DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.

          Possible values include:
          • "CREATE_FAILED"
          • "RUNNING"
          • "DELETED"
          • "DELETE_FAILED"
          • "PAUSED"
          • "OPERATION_IN_PROGRESS"
        • SourceConfigurationrequired — (map)

          The source deployed to the App Runner service. It can be a code or an image repository.

          • CodeRepository — (map)

            The description of a source code repository.

            You must provide either this member or ImageRepository (but not both).

            • RepositoryUrlrequired — (String)

              The location of the repository that contains the source code.

            • SourceCodeVersionrequired — (map)

              The version that should be used within the source code repository.

              • Typerequired — (String)

                The type of version identifier.

                For a git-based repository, branches represent versions.

                Possible values include:
                • "BRANCH"
              • Valuerequired — (String)

                A source code version.

                For a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to the branch.

            • CodeConfiguration — (map)

              Configuration for building and running the service from a source code repository.

              • ConfigurationSourcerequired — (String)

                The source of the App Runner configuration. Values are interpreted as follows:

                • REPOSITORY – App Runner reads configuration values from the apprunner.yaml file in the source code repository and ignores CodeConfigurationValues.

                • API – App Runner uses configuration values provided in CodeConfigurationValues and ignores the apprunner.yaml file in the source code repository.

                Possible values include:
                • "REPOSITORY"
                • "API"
              • CodeConfigurationValues — (map)

                The basic configuration for building and running the App Runner service. Use it to quickly launch an App Runner service without providing a apprunner.yaml file in the source code repository (or ignoring the file if it exists).

                • Runtimerequired — (String)

                  A runtime environment type for building and running an App Runner service. It represents a programming language runtime.

                  Possible values include:
                  • "PYTHON_3"
                  • "NODEJS_12"
                • BuildCommand — (String)

                  The command App Runner runs to build your application.

                • StartCommand — (String)

                  The command App Runner runs to start your application.

                • Port — (String)

                  The port that your application listens to in the container.

                  Default: 8080

                • RuntimeEnvironmentVariables — (map<String>)

                  The environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

          • ImageRepository — (map)

            The description of a source image repository.

            You must provide either this member or CodeRepository (but not both).

            • ImageIdentifierrequired — (String)

              The identifier of an image.

              For an image in Amazon Elastic Container Registry (Amazon ECR), this is an image name. For the image name format, see Pulling an image in the Amazon ECR User Guide.

            • ImageConfiguration — (map)

              Configuration for running the identified image.

              • RuntimeEnvironmentVariables — (map<String>)

                Environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

              • StartCommand — (String)

                An optional command that App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.

              • Port — (String)

                The port that your application listens to in the container.

                Default: 8080

            • ImageRepositoryTyperequired — (String)

              The type of the image repository. This reflects the repository provider and whether the repository is private or public.

              Possible values include:
              • "ECR"
              • "ECR_PUBLIC"
          • AutoDeploymentsEnabled — (Boolean)

            If true, continuous integration from the source repository is enabled for the App Runner service. Each repository change (source code commit or new image version) starts a deployment.

            Default: true

          • AuthenticationConfiguration — (map)

            Describes the resources that are needed to authenticate access to some source repositories.

            • ConnectionArn — (String)

              The Amazon Resource Name (ARN) of the App Runner connection that enables the App Runner service to connect to a source repository. It's required for GitHub code repositories.

            • AccessRoleArn — (String)

              The Amazon Resource Name (ARN) of the IAM role that grants the App Runner service access to a source repository. It's required for ECR image repositories (but not for ECR Public repositories).

        • InstanceConfigurationrequired — (map)

          The runtime configuration of instances (scaling units) of this service.

          • Cpu — (String)

            The number of CPU units reserved for each instance of your App Runner service.

            Default: 1 vCPU

          • Memory — (String)

            The amount of memory, in MB or GB, reserved for each instance of your App Runner service.

            Default: 2 GB

          • InstanceRoleArn — (String)

            The Amazon Resource Name (ARN) of an IAM role that provides permissions to your App Runner service. These are permissions that your code needs when it calls any AWS APIs.

        • EncryptionConfiguration — (map)

          The encryption key that App Runner uses to encrypt the service logs and the copy of the source repository that App Runner maintains for the service. It can be either a customer-provided encryption key or an AWS managed CMK.

          • KmsKeyrequired — (String)

            The ARN of the KMS key that's used for encryption.

        • HealthCheckConfiguration — (map)

          The settings for the health check that App Runner performs to monitor the health of this service.

          • Protocol — (String)

            The IP protocol that App Runner uses to perform health checks for your service.

            If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.

            Default: TCP

            Possible values include:
            • "TCP"
            • "HTTP"
          • Path — (String)

            The URL that health check requests are sent to.

            Path is only applicable when you set Protocol to HTTP.

            Default: "/"

          • Interval — (Integer)

            The time interval, in seconds, between health checks.

            Default: 5

          • Timeout — (Integer)

            The time, in seconds, to wait for a health check response before deciding it failed.

            Default: 2

          • HealthyThreshold — (Integer)

            The number of consecutive checks that must succeed before App Runner decides that the service is healthy.

            Default: 3

          • UnhealthyThreshold — (Integer)

            The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

            Default: 3

        • AutoScalingConfigurationSummaryrequired — (map)

          Summary information for the App Runner automatic scaling configuration resource that's associated with this service.

          • AutoScalingConfigurationArn — (String)

            The Amazon Resource Name (ARN) of this auto scaling configuration.

          • AutoScalingConfigurationName — (String)

            The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.

          • AutoScalingConfigurationRevision — (Integer)

            The revision of this auto scaling configuration. It's unique among all the active configurations ("Status": "ACTIVE") with the same AutoScalingConfigurationName.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disassociateCustomDomain(params = {}, callback) ⇒ AWS.Request

Disassociate a custom domain name from an AWS 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.

Service Reference:

Examples:

Calling the disassociateCustomDomain operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  ServiceArn: 'STRING_VALUE' /* required */
};
apprunner.disassociateCustomDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ServiceArn — (String)

      The Amazon Resource Name (ARN) of the App Runner service that you want to disassociate a custom domain name from.

    • DomainName — (String)

      The domain name that you want to disassociate from the App Runner service.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DNSTarget — (String)

        The App Runner subdomain of the App Runner service. The disassociated custom domain name was mapped to this target name.

      • ServiceArn — (String)

        The Amazon Resource Name (ARN) of the App Runner service that a custom domain name is disassociated from.

      • CustomDomain — (map)

        A description of the domain name that's being disassociated.

        • DomainNamerequired — (String)

          An associated custom domain endpoint. It can be 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).

        • EnableWWWSubdomainrequired — (Boolean)

          When true, the subdomain www.DomainName is associated with the App Runner service in addition to the base domain.

        • CertificateValidationRecords — (Array<map>)

          A list of certificate CNAME records that's used for this domain name.

          • Name — (String)

            The certificate CNAME record name.

          • Type — (String)

            The record type, always CNAME.

          • Value — (String)

            The certificate CNAME record value.

          • Status — (String)

            The current state of the certificate CNAME record validation. It should change to SUCCESS after App Runner completes validation with your DNS.

            Possible values include:
            • "PENDING_VALIDATION"
            • "SUCCESS"
            • "FAILED"
        • Statusrequired — (String)

          The current state of the domain name association.

          Possible values include:
          • "CREATING"
          • "CREATE_FAILED"
          • "ACTIVE"
          • "DELETING"
          • "DELETE_FAILED"
          • "PENDING_CERTIFICATE_DNS_VALIDATION"
          • "BINDING_CERTIFICATE"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAutoScalingConfigurations(params = {}, callback) ⇒ AWS.Request

Returns a list of AWS App Runner automatic scaling configurations in your AWS account. You can query the revisions for a specific configuration name or the revisions for all configurations in your account. You can optionally query only the latest revision of each requested name.

Service Reference:

Examples:

Calling the listAutoScalingConfigurations operation

var params = {
  AutoScalingConfigurationName: 'STRING_VALUE',
  LatestOnly: true || false,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
apprunner.listAutoScalingConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AutoScalingConfigurationName — (String)

      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 configurations.

    • LatestOnly — (Boolean)

      Set to true to list only the latest revision for each requested configuration name.

      Keep as false to list all revisions for each requested configuration name.

      Default: false

    • MaxResults — (Integer)

      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 — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AutoScalingConfigurationSummaryList — (Array<map>)

        A list of summary information records for auto scaling configurations. In a paginated request, the request returns up to MaxResults records for each call.

        • AutoScalingConfigurationArn — (String)

          The Amazon Resource Name (ARN) of this auto scaling configuration.

        • AutoScalingConfigurationName — (String)

          The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.

        • AutoScalingConfigurationRevision — (Integer)

          The revision of this auto scaling configuration. It's unique among all the active configurations ("Status": "ACTIVE") with the same AutoScalingConfigurationName.

      • NextToken — (String)

        The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listConnections(params = {}, callback) ⇒ AWS.Request

Returns a list of AWS App Runner connections that are associated with your AWS account.

Service Reference:

Examples:

Calling the listConnections operation

var params = {
  ConnectionName: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
apprunner.listConnections(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConnectionName — (String)

      If specified, only this connection is returned. If not specified, the result isn't filtered by name.

    • MaxResults — (Integer)

      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 — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConnectionSummaryList — (Array<map>)

        A list of summary information records for connections. In a paginated request, the request returns up to MaxResults records for each call.

        • ConnectionName — (String)

          The customer-provided connection name.

        • ConnectionArn — (String)

          The Amazon Resource Name (ARN) of this connection.

        • ProviderType — (String)

          The source repository provider.

          Possible values include:
          • "GITHUB"
        • Status — (String)

          The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an App Runner service.

          Possible values include:
          • "PENDING_HANDSHAKE"
          • "AVAILABLE"
          • "ERROR"
          • "DELETED"
        • CreatedAt — (Date)

          The App Runner connection creation time, expressed as a Unix time stamp.

      • NextToken — (String)

        The token that you can pass in a subsequent request to get the next result page. Returned in a paginated request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listOperations(params = {}, callback) ⇒ AWS.Request

Return a list of operations that occurred on an AWS 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.

Service Reference:

Examples:

Calling the listOperations operation

var params = {
  ServiceArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
apprunner.listOperations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ServiceArn — (String)

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

    • NextToken — (String)

      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.

    • MaxResults — (Integer)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OperationSummaryList — (Array<map>)

        A list of operation summary information records. In a paginated request, the request returns up to MaxResults records for each call.

        • Id — (String)

          A unique ID of this operation. It's unique in the scope of the App Runner service.

        • Type — (String)

          The type of operation. It indicates a specific action that occured.

          Possible values include:
          • "START_DEPLOYMENT"
          • "CREATE_SERVICE"
          • "PAUSE_SERVICE"
          • "RESUME_SERVICE"
          • "DELETE_SERVICE"
        • Status — (String)

          The current state of the operation.

          Possible values include:
          • "PENDING"
          • "IN_PROGRESS"
          • "FAILED"
          • "SUCCEEDED"
          • "ROLLBACK_IN_PROGRESS"
          • "ROLLBACK_FAILED"
          • "ROLLBACK_SUCCEEDED"
        • TargetArn — (String)

          The Amazon Resource Name (ARN) of the resource that the operation acted on (for example, an App Runner service).

        • StartedAt — (Date)

          The time when the operation started. It's in the Unix time stamp format.

        • EndedAt — (Date)

          The time when the operation ended. It's in the Unix time stamp format.

        • UpdatedAt — (Date)

          The time when the operation was last updated. It's in the Unix time stamp format.

      • NextToken — (String)

        The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listServices(params = {}, callback) ⇒ AWS.Request

Returns a list of running AWS App Runner services in your AWS account.

Service Reference:

Examples:

Calling the listServices operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
apprunner.listServices(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      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.

    • MaxResults — (Integer)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ServiceSummaryList — (Array<map>)

        A list of service summary information records. In a paginated request, the request returns up to MaxResults records for each call.

        • ServiceName — (String)

          The customer-provided service name.

        • ServiceId — (String)

          An ID that App Runner generated for this service. It's unique within the AWS Region.

        • ServiceArn — (String)

          The Amazon Resource Name (ARN) of this service.

        • ServiceUrl — (String)

          A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.

        • CreatedAt — (Date)

          The time when the App Runner service was created. It's in the Unix time stamp format.

        • UpdatedAt — (Date)

          The time when the App Runner service was last updated. It's in theUnix time stamp format.

        • Status — (String)

          The current state of the App Runner service. These particular values mean the following.

          • CREATE_FAILED – The service failed to create. Read the failure events and logs, change any parameters that need to be fixed, and retry the call to create the service.

            The failed service isn't usable, and still counts towards your service quota. When you're done analyzing the failure, delete the service.

          • DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.

          Possible values include:
          • "CREATE_FAILED"
          • "RUNNING"
          • "DELETED"
          • "DELETE_FAILED"
          • "PAUSED"
          • "OPERATION_IN_PROGRESS"
      • NextToken — (String)

        The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
apprunner.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        A list of the tag key-value pairs that are associated with the resource.

        • Key — (String)

          The key of the tag.

        • Value — (String)

          The value of the tag.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

pauseService(params = {}, callback) ⇒ AWS.Request

Pause an active AWS 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.

Service Reference:

Examples:

Calling the pauseService operation

var params = {
  ServiceArn: 'STRING_VALUE' /* required */
};
apprunner.pauseService(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ServiceArn — (String)

      The Amazon Resource Name (ARN) of the App Runner service that you want to pause.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Service — (map)

        A description of the App Runner service that this request just paused.

        • ServiceNamerequired — (String)

          The customer-provided service name.

        • ServiceIdrequired — (String)

          An ID that App Runner generated for this service. It's unique within the AWS Region.

        • ServiceArnrequired — (String)

          The Amazon Resource Name (ARN) of this service.

        • ServiceUrlrequired — (String)

          A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.

        • CreatedAtrequired — (Date)

          The time when the App Runner service was created. It's in the Unix time stamp format.

        • UpdatedAtrequired — (Date)

          The time when the App Runner service was last updated at. It's in the Unix time stamp format.

        • DeletedAt — (Date)

          The time when the App Runner service was deleted. It's in the Unix time stamp format.

        • Statusrequired — (String)

          The current state of the App Runner service. These particular values mean the following.

          • CREATE_FAILED – The service failed to create. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and retry the call to create the service.

            The failed service isn't usable, and still counts towards your service quota. When you're done analyzing the failure, delete the service.

          • DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.

          Possible values include:
          • "CREATE_FAILED"
          • "RUNNING"
          • "DELETED"
          • "DELETE_FAILED"
          • "PAUSED"
          • "OPERATION_IN_PROGRESS"
        • SourceConfigurationrequired — (map)

          The source deployed to the App Runner service. It can be a code or an image repository.

          • CodeRepository — (map)

            The description of a source code repository.

            You must provide either this member or ImageRepository (but not both).

            • RepositoryUrlrequired — (String)

              The location of the repository that contains the source code.

            • SourceCodeVersionrequired — (map)

              The version that should be used within the source code repository.

              • Typerequired — (String)

                The type of version identifier.

                For a git-based repository, branches represent versions.

                Possible values include:
                • "BRANCH"
              • Valuerequired — (String)

                A source code version.

                For a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to the branch.

            • CodeConfiguration — (map)

              Configuration for building and running the service from a source code repository.

              • ConfigurationSourcerequired — (String)

                The source of the App Runner configuration. Values are interpreted as follows:

                • REPOSITORY – App Runner reads configuration values from the apprunner.yaml file in the source code repository and ignores CodeConfigurationValues.

                • API – App Runner uses configuration values provided in CodeConfigurationValues and ignores the apprunner.yaml file in the source code repository.

                Possible values include:
                • "REPOSITORY"
                • "API"
              • CodeConfigurationValues — (map)

                The basic configuration for building and running the App Runner service. Use it to quickly launch an App Runner service without providing a apprunner.yaml file in the source code repository (or ignoring the file if it exists).

                • Runtimerequired — (String)

                  A runtime environment type for building and running an App Runner service. It represents a programming language runtime.

                  Possible values include:
                  • "PYTHON_3"
                  • "NODEJS_12"
                • BuildCommand — (String)

                  The command App Runner runs to build your application.

                • StartCommand — (String)

                  The command App Runner runs to start your application.

                • Port — (String)

                  The port that your application listens to in the container.

                  Default: 8080

                • RuntimeEnvironmentVariables — (map<String>)

                  The environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

          • ImageRepository — (map)

            The description of a source image repository.

            You must provide either this member or CodeRepository (but not both).

            • ImageIdentifierrequired — (String)

              The identifier of an image.

              For an image in Amazon Elastic Container Registry (Amazon ECR), this is an image name. For the image name format, see Pulling an image in the Amazon ECR User Guide.

            • ImageConfiguration — (map)

              Configuration for running the identified image.

              • RuntimeEnvironmentVariables — (map<String>)

                Environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

              • StartCommand — (String)

                An optional command that App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.

              • Port — (String)

                The port that your application listens to in the container.

                Default: 8080

            • ImageRepositoryTyperequired — (String)

              The type of the image repository. This reflects the repository provider and whether the repository is private or public.

              Possible values include:
              • "ECR"
              • "ECR_PUBLIC"
          • AutoDeploymentsEnabled — (Boolean)

            If true, continuous integration from the source repository is enabled for the App Runner service. Each repository change (source code commit or new image version) starts a deployment.

            Default: true

          • AuthenticationConfiguration — (map)

            Describes the resources that are needed to authenticate access to some source repositories.

            • ConnectionArn — (String)

              The Amazon Resource Name (ARN) of the App Runner connection that enables the App Runner service to connect to a source repository. It's required for GitHub code repositories.

            • AccessRoleArn — (String)

              The Amazon Resource Name (ARN) of the IAM role that grants the App Runner service access to a source repository. It's required for ECR image repositories (but not for ECR Public repositories).

        • InstanceConfigurationrequired — (map)

          The runtime configuration of instances (scaling units) of this service.

          • Cpu — (String)

            The number of CPU units reserved for each instance of your App Runner service.

            Default: 1 vCPU

          • Memory — (String)

            The amount of memory, in MB or GB, reserved for each instance of your App Runner service.

            Default: 2 GB

          • InstanceRoleArn — (String)

            The Amazon Resource Name (ARN) of an IAM role that provides permissions to your App Runner service. These are permissions that your code needs when it calls any AWS APIs.

        • EncryptionConfiguration — (map)

          The encryption key that App Runner uses to encrypt the service logs and the copy of the source repository that App Runner maintains for the service. It can be either a customer-provided encryption key or an AWS managed CMK.

          • KmsKeyrequired — (String)

            The ARN of the KMS key that's used for encryption.

        • HealthCheckConfiguration — (map)

          The settings for the health check that App Runner performs to monitor the health of this service.

          • Protocol — (String)

            The IP protocol that App Runner uses to perform health checks for your service.

            If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.

            Default: TCP

            Possible values include:
            • "TCP"
            • "HTTP"
          • Path — (String)

            The URL that health check requests are sent to.

            Path is only applicable when you set Protocol to HTTP.

            Default: "/"

          • Interval — (Integer)

            The time interval, in seconds, between health checks.

            Default: 5

          • Timeout — (Integer)

            The time, in seconds, to wait for a health check response before deciding it failed.

            Default: 2

          • HealthyThreshold — (Integer)

            The number of consecutive checks that must succeed before App Runner decides that the service is healthy.

            Default: 3

          • UnhealthyThreshold — (Integer)

            The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

            Default: 3

        • AutoScalingConfigurationSummaryrequired — (map)

          Summary information for the App Runner automatic scaling configuration resource that's associated with this service.

          • AutoScalingConfigurationArn — (String)

            The Amazon Resource Name (ARN) of this auto scaling configuration.

          • AutoScalingConfigurationName — (String)

            The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.

          • AutoScalingConfigurationRevision — (Integer)

            The revision of this auto scaling configuration. It's unique among all the active configurations ("Status": "ACTIVE") with the same AutoScalingConfigurationName.

      • OperationId — (String)

        The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track the operation's progress.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

resumeService(params = {}, callback) ⇒ AWS.Request

Resume an active AWS 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.

Service Reference:

Examples:

Calling the resumeService operation

var params = {
  ServiceArn: 'STRING_VALUE' /* required */
};
apprunner.resumeService(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ServiceArn — (String)

      The Amazon Resource Name (ARN) of the App Runner service that you want to resume.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Service — (map)

        A description of the App Runner service that this request just resumed.

        • ServiceNamerequired — (String)

          The customer-provided service name.

        • ServiceIdrequired — (String)

          An ID that App Runner generated for this service. It's unique within the AWS Region.

        • ServiceArnrequired — (String)

          The Amazon Resource Name (ARN) of this service.

        • ServiceUrlrequired — (String)

          A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.

        • CreatedAtrequired — (Date)

          The time when the App Runner service was created. It's in the Unix time stamp format.

        • UpdatedAtrequired — (Date)

          The time when the App Runner service was last updated at. It's in the Unix time stamp format.

        • DeletedAt — (Date)

          The time when the App Runner service was deleted. It's in the Unix time stamp format.

        • Statusrequired — (String)

          The current state of the App Runner service. These particular values mean the following.

          • CREATE_FAILED – The service failed to create. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and retry the call to create the service.

            The failed service isn't usable, and still counts towards your service quota. When you're done analyzing the failure, delete the service.

          • DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.

          Possible values include:
          • "CREATE_FAILED"
          • "RUNNING"
          • "DELETED"
          • "DELETE_FAILED"
          • "PAUSED"
          • "OPERATION_IN_PROGRESS"
        • SourceConfigurationrequired — (map)

          The source deployed to the App Runner service. It can be a code or an image repository.

          • CodeRepository — (map)

            The description of a source code repository.

            You must provide either this member or ImageRepository (but not both).

            • RepositoryUrlrequired — (String)

              The location of the repository that contains the source code.

            • SourceCodeVersionrequired — (map)

              The version that should be used within the source code repository.

              • Typerequired — (String)

                The type of version identifier.

                For a git-based repository, branches represent versions.

                Possible values include:
                • "BRANCH"
              • Valuerequired — (String)

                A source code version.

                For a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to the branch.

            • CodeConfiguration — (map)

              Configuration for building and running the service from a source code repository.

              • ConfigurationSourcerequired — (String)

                The source of the App Runner configuration. Values are interpreted as follows:

                • REPOSITORY – App Runner reads configuration values from the apprunner.yaml file in the source code repository and ignores CodeConfigurationValues.

                • API – App Runner uses configuration values provided in CodeConfigurationValues and ignores the apprunner.yaml file in the source code repository.

                Possible values include:
                • "REPOSITORY"
                • "API"
              • CodeConfigurationValues — (map)

                The basic configuration for building and running the App Runner service. Use it to quickly launch an App Runner service without providing a apprunner.yaml file in the source code repository (or ignoring the file if it exists).

                • Runtimerequired — (String)

                  A runtime environment type for building and running an App Runner service. It represents a programming language runtime.

                  Possible values include:
                  • "PYTHON_3"
                  • "NODEJS_12"
                • BuildCommand — (String)

                  The command App Runner runs to build your application.

                • StartCommand — (String)

                  The command App Runner runs to start your application.

                • Port — (String)

                  The port that your application listens to in the container.

                  Default: 8080

                • RuntimeEnvironmentVariables — (map<String>)

                  The environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

          • ImageRepository — (map)

            The description of a source image repository.

            You must provide either this member or CodeRepository (but not both).

            • ImageIdentifierrequired — (String)

              The identifier of an image.

              For an image in Amazon Elastic Container Registry (Amazon ECR), this is an image name. For the image name format, see Pulling an image in the Amazon ECR User Guide.

            • ImageConfiguration — (map)

              Configuration for running the identified image.

              • RuntimeEnvironmentVariables — (map<String>)

                Environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

              • StartCommand — (String)

                An optional command that App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.

              • Port — (String)

                The port that your application listens to in the container.

                Default: 8080

            • ImageRepositoryTyperequired — (String)

              The type of the image repository. This reflects the repository provider and whether the repository is private or public.

              Possible values include:
              • "ECR"
              • "ECR_PUBLIC"
          • AutoDeploymentsEnabled — (Boolean)

            If true, continuous integration from the source repository is enabled for the App Runner service. Each repository change (source code commit or new image version) starts a deployment.

            Default: true

          • AuthenticationConfiguration — (map)

            Describes the resources that are needed to authenticate access to some source repositories.

            • ConnectionArn — (String)

              The Amazon Resource Name (ARN) of the App Runner connection that enables the App Runner service to connect to a source repository. It's required for GitHub code repositories.

            • AccessRoleArn — (String)

              The Amazon Resource Name (ARN) of the IAM role that grants the App Runner service access to a source repository. It's required for ECR image repositories (but not for ECR Public repositories).

        • InstanceConfigurationrequired — (map)

          The runtime configuration of instances (scaling units) of this service.

          • Cpu — (String)

            The number of CPU units reserved for each instance of your App Runner service.

            Default: 1 vCPU

          • Memory — (String)

            The amount of memory, in MB or GB, reserved for each instance of your App Runner service.

            Default: 2 GB

          • InstanceRoleArn — (String)

            The Amazon Resource Name (ARN) of an IAM role that provides permissions to your App Runner service. These are permissions that your code needs when it calls any AWS APIs.

        • EncryptionConfiguration — (map)

          The encryption key that App Runner uses to encrypt the service logs and the copy of the source repository that App Runner maintains for the service. It can be either a customer-provided encryption key or an AWS managed CMK.

          • KmsKeyrequired — (String)

            The ARN of the KMS key that's used for encryption.

        • HealthCheckConfiguration — (map)

          The settings for the health check that App Runner performs to monitor the health of this service.

          • Protocol — (String)

            The IP protocol that App Runner uses to perform health checks for your service.

            If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.

            Default: TCP

            Possible values include:
            • "TCP"
            • "HTTP"
          • Path — (String)

            The URL that health check requests are sent to.

            Path is only applicable when you set Protocol to HTTP.

            Default: "/"

          • Interval — (Integer)

            The time interval, in seconds, between health checks.

            Default: 5

          • Timeout — (Integer)

            The time, in seconds, to wait for a health check response before deciding it failed.

            Default: 2

          • HealthyThreshold — (Integer)

            The number of consecutive checks that must succeed before App Runner decides that the service is healthy.

            Default: 3

          • UnhealthyThreshold — (Integer)

            The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

            Default: 3

        • AutoScalingConfigurationSummaryrequired — (map)

          Summary information for the App Runner automatic scaling configuration resource that's associated with this service.

          • AutoScalingConfigurationArn — (String)

            The Amazon Resource Name (ARN) of this auto scaling configuration.

          • AutoScalingConfigurationName — (String)

            The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.

          • AutoScalingConfigurationRevision — (Integer)

            The revision of this auto scaling configuration. It's unique among all the active configurations ("Status": "ACTIVE") with the same AutoScalingConfigurationName.

      • OperationId — (String)

        The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track the operation's progress.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startDeployment(params = {}, callback) ⇒ AWS.Request

Initiate a manual deployment of the latest commit in a source code repository or the latest image in a source image repository to an AWS 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.

Service Reference:

Examples:

Calling the startDeployment operation

var params = {
  ServiceArn: 'STRING_VALUE' /* required */
};
apprunner.startDeployment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ServiceArn — (String)

      The Amazon Resource Name (ARN) of the App Runner service that you want to manually deploy to.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OperationId — (String)

        The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track the operation's progress.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
apprunner.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      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 — (Array<map>)

      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.

      • Key — (String)

        The key of the tag.

      • Value — (String)

        The value of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Remove tags from an App Runner resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
apprunner.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      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.

    • TagKeys — (Array<String>)

      A list of tag keys that you want to remove.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateService(params = {}, callback) ⇒ AWS.Request

Update an AWS 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.

Service Reference:

Examples:

Calling the updateService operation

var params = {
  ServiceArn: 'STRING_VALUE', /* required */
  AutoScalingConfigurationArn: 'STRING_VALUE',
  HealthCheckConfiguration: {
    HealthyThreshold: 'NUMBER_VALUE',
    Interval: 'NUMBER_VALUE',
    Path: 'STRING_VALUE',
    Protocol: TCP | HTTP,
    Timeout: 'NUMBER_VALUE',
    UnhealthyThreshold: 'NUMBER_VALUE'
  },
  InstanceConfiguration: {
    Cpu: 'STRING_VALUE',
    InstanceRoleArn: 'STRING_VALUE',
    Memory: 'STRING_VALUE'
  },
  SourceConfiguration: {
    AuthenticationConfiguration: {
      AccessRoleArn: 'STRING_VALUE',
      ConnectionArn: 'STRING_VALUE'
    },
    AutoDeploymentsEnabled: true || false,
    CodeRepository: {
      RepositoryUrl: 'STRING_VALUE', /* required */
      SourceCodeVersion: { /* required */
        Type: BRANCH, /* required */
        Value: 'STRING_VALUE' /* required */
      },
      CodeConfiguration: {
        ConfigurationSource: REPOSITORY | API, /* required */
        CodeConfigurationValues: {
          Runtime: PYTHON_3 | NODEJS_12, /* required */
          BuildCommand: 'STRING_VALUE',
          Port: 'STRING_VALUE',
          RuntimeEnvironmentVariables: {
            '<RuntimeEnvironmentVariablesKey>': 'STRING_VALUE',
            /* '<RuntimeEnvironmentVariablesKey>': ... */
          },
          StartCommand: 'STRING_VALUE'
        }
      }
    },
    ImageRepository: {
      ImageIdentifier: 'STRING_VALUE', /* required */
      ImageRepositoryType: ECR | ECR_PUBLIC, /* required */
      ImageConfiguration: {
        Port: 'STRING_VALUE',
        RuntimeEnvironmentVariables: {
          '<RuntimeEnvironmentVariablesKey>': 'STRING_VALUE',
          /* '<RuntimeEnvironmentVariablesKey>': ... */
        },
        StartCommand: 'STRING_VALUE'
      }
    }
  }
};
apprunner.updateService(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ServiceArn — (String)

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

    • SourceConfiguration — (map)

      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.

      • CodeRepository — (map)

        The description of a source code repository.

        You must provide either this member or ImageRepository (but not both).

        • RepositoryUrlrequired — (String)

          The location of the repository that contains the source code.

        • SourceCodeVersionrequired — (map)

          The version that should be used within the source code repository.

          • Typerequired — (String)

            The type of version identifier.

            For a git-based repository, branches represent versions.

            Possible values include:
            • "BRANCH"
          • Valuerequired — (String)

            A source code version.

            For a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to the branch.

        • CodeConfiguration — (map)

          Configuration for building and running the service from a source code repository.

          • ConfigurationSourcerequired — (String)

            The source of the App Runner configuration. Values are interpreted as follows:

            • REPOSITORY – App Runner reads configuration values from the apprunner.yaml file in the source code repository and ignores CodeConfigurationValues.

            • API – App Runner uses configuration values provided in CodeConfigurationValues and ignores the apprunner.yaml file in the source code repository.

            Possible values include:
            • "REPOSITORY"
            • "API"
          • CodeConfigurationValues — (map)

            The basic configuration for building and running the App Runner service. Use it to quickly launch an App Runner service without providing a apprunner.yaml file in the source code repository (or ignoring the file if it exists).

            • Runtimerequired — (String)

              A runtime environment type for building and running an App Runner service. It represents a programming language runtime.

              Possible values include:
              • "PYTHON_3"
              • "NODEJS_12"
            • BuildCommand — (String)

              The command App Runner runs to build your application.

            • StartCommand — (String)

              The command App Runner runs to start your application.

            • Port — (String)

              The port that your application listens to in the container.

              Default: 8080

            • RuntimeEnvironmentVariables — (map<String>)

              The environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

      • ImageRepository — (map)

        The description of a source image repository.

        You must provide either this member or CodeRepository (but not both).

        • ImageIdentifierrequired — (String)

          The identifier of an image.

          For an image in Amazon Elastic Container Registry (Amazon ECR), this is an image name. For the image name format, see Pulling an image in the Amazon ECR User Guide.

        • ImageConfiguration — (map)

          Configuration for running the identified image.

          • RuntimeEnvironmentVariables — (map<String>)

            Environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

          • StartCommand — (String)

            An optional command that App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.

          • Port — (String)

            The port that your application listens to in the container.

            Default: 8080

        • ImageRepositoryTyperequired — (String)

          The type of the image repository. This reflects the repository provider and whether the repository is private or public.

          Possible values include:
          • "ECR"
          • "ECR_PUBLIC"
      • AutoDeploymentsEnabled — (Boolean)

        If true, continuous integration from the source repository is enabled for the App Runner service. Each repository change (source code commit or new image version) starts a deployment.

        Default: true

      • AuthenticationConfiguration — (map)

        Describes the resources that are needed to authenticate access to some source repositories.

        • ConnectionArn — (String)

          The Amazon Resource Name (ARN) of the App Runner connection that enables the App Runner service to connect to a source repository. It's required for GitHub code repositories.

        • AccessRoleArn — (String)

          The Amazon Resource Name (ARN) of the IAM role that grants the App Runner service access to a source repository. It's required for ECR image repositories (but not for ECR Public repositories).

    • InstanceConfiguration — (map)

      The runtime configuration to apply to instances (scaling units) of the App Runner service.

      • Cpu — (String)

        The number of CPU units reserved for each instance of your App Runner service.

        Default: 1 vCPU

      • Memory — (String)

        The amount of memory, in MB or GB, reserved for each instance of your App Runner service.

        Default: 2 GB

      • InstanceRoleArn — (String)

        The Amazon Resource Name (ARN) of an IAM role that provides permissions to your App Runner service. These are permissions that your code needs when it calls any AWS APIs.

    • AutoScalingConfigurationArn — (String)

      The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service.

    • HealthCheckConfiguration — (map)

      The settings for the health check that AWS App Runner performs to monitor the health of your service.

      • Protocol — (String)

        The IP protocol that App Runner uses to perform health checks for your service.

        If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.

        Default: TCP

        Possible values include:
        • "TCP"
        • "HTTP"
      • Path — (String)

        The URL that health check requests are sent to.

        Path is only applicable when you set Protocol to HTTP.

        Default: "/"

      • Interval — (Integer)

        The time interval, in seconds, between health checks.

        Default: 5

      • Timeout — (Integer)

        The time, in seconds, to wait for a health check response before deciding it failed.

        Default: 2

      • HealthyThreshold — (Integer)

        The number of consecutive checks that must succeed before App Runner decides that the service is healthy.

        Default: 3

      • UnhealthyThreshold — (Integer)

        The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

        Default: 3

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Service — (map)

        A description of the App Runner service updated by this request. All configuration values in the returned Service structure reflect configuration changes that are being applied by this request.

        • ServiceNamerequired — (String)

          The customer-provided service name.

        • ServiceIdrequired — (String)

          An ID that App Runner generated for this service. It's unique within the AWS Region.

        • ServiceArnrequired — (String)

          The Amazon Resource Name (ARN) of this service.

        • ServiceUrlrequired — (String)

          A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.

        • CreatedAtrequired — (Date)

          The time when the App Runner service was created. It's in the Unix time stamp format.

        • UpdatedAtrequired — (Date)

          The time when the App Runner service was last updated at. It's in the Unix time stamp format.

        • DeletedAt — (Date)

          The time when the App Runner service was deleted. It's in the Unix time stamp format.

        • Statusrequired — (String)

          The current state of the App Runner service. These particular values mean the following.

          • CREATE_FAILED – The service failed to create. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and retry the call to create the service.

            The failed service isn't usable, and still counts towards your service quota. When you're done analyzing the failure, delete the service.

          • DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.

          Possible values include:
          • "CREATE_FAILED"
          • "RUNNING"
          • "DELETED"
          • "DELETE_FAILED"
          • "PAUSED"
          • "OPERATION_IN_PROGRESS"
        • SourceConfigurationrequired — (map)

          The source deployed to the App Runner service. It can be a code or an image repository.

          • CodeRepository — (map)

            The description of a source code repository.

            You must provide either this member or ImageRepository (but not both).

            • RepositoryUrlrequired — (String)

              The location of the repository that contains the source code.

            • SourceCodeVersionrequired — (map)

              The version that should be used within the source code repository.

              • Typerequired — (String)

                The type of version identifier.

                For a git-based repository, branches represent versions.

                Possible values include:
                • "BRANCH"
              • Valuerequired — (String)

                A source code version.

                For a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to the branch.

            • CodeConfiguration — (map)

              Configuration for building and running the service from a source code repository.

              • ConfigurationSourcerequired — (String)

                The source of the App Runner configuration. Values are interpreted as follows:

                • REPOSITORY – App Runner reads configuration values from the apprunner.yaml file in the source code repository and ignores CodeConfigurationValues.

                • API – App Runner uses configuration values provided in CodeConfigurationValues and ignores the apprunner.yaml file in the source code repository.

                Possible values include:
                • "REPOSITORY"
                • "API"
              • CodeConfigurationValues — (map)

                The basic configuration for building and running the App Runner service. Use it to quickly launch an App Runner service without providing a apprunner.yaml file in the source code repository (or ignoring the file if it exists).

                • Runtimerequired — (String)

                  A runtime environment type for building and running an App Runner service. It represents a programming language runtime.

                  Possible values include:
                  • "PYTHON_3"
                  • "NODEJS_12"
                • BuildCommand — (String)

                  The command App Runner runs to build your application.

                • StartCommand — (String)

                  The command App Runner runs to start your application.

                • Port — (String)

                  The port that your application listens to in the container.

                  Default: 8080

                • RuntimeEnvironmentVariables — (map<String>)

                  The environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

          • ImageRepository — (map)

            The description of a source image repository.

            You must provide either this member or CodeRepository (but not both).

            • ImageIdentifierrequired — (String)

              The identifier of an image.

              For an image in Amazon Elastic Container Registry (Amazon ECR), this is an image name. For the image name format, see Pulling an image in the Amazon ECR User Guide.

            • ImageConfiguration — (map)

              Configuration for running the identified image.

              • RuntimeEnvironmentVariables — (map<String>)

                Environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER are reserved for system use and aren't valid.

              • StartCommand — (String)

                An optional command that App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.

              • Port — (String)

                The port that your application listens to in the container.

                Default: 8080

            • ImageRepositoryTyperequired — (String)

              The type of the image repository. This reflects the repository provider and whether the repository is private or public.

              Possible values include:
              • "ECR"
              • "ECR_PUBLIC"
          • AutoDeploymentsEnabled — (Boolean)

            If true, continuous integration from the source repository is enabled for the App Runner service. Each repository change (source code commit or new image version) starts a deployment.

            Default: true

          • AuthenticationConfiguration — (map)

            Describes the resources that are needed to authenticate access to some source repositories.

            • ConnectionArn — (String)

              The Amazon Resource Name (ARN) of the App Runner connection that enables the App Runner service to connect to a source repository. It's required for GitHub code repositories.

            • AccessRoleArn — (String)

              The Amazon Resource Name (ARN) of the IAM role that grants the App Runner service access to a source repository. It's required for ECR image repositories (but not for ECR Public repositories).

        • InstanceConfigurationrequired — (map)

          The runtime configuration of instances (scaling units) of this service.

          • Cpu — (String)

            The number of CPU units reserved for each instance of your App Runner service.

            Default: 1 vCPU

          • Memory — (String)

            The amount of memory, in MB or GB, reserved for each instance of your App Runner service.

            Default: 2 GB

          • InstanceRoleArn — (String)

            The Amazon Resource Name (ARN) of an IAM role that provides permissions to your App Runner service. These are permissions that your code needs when it calls any AWS APIs.

        • EncryptionConfiguration — (map)

          The encryption key that App Runner uses to encrypt the service logs and the copy of the source repository that App Runner maintains for the service. It can be either a customer-provided encryption key or an AWS managed CMK.

          • KmsKeyrequired — (String)

            The ARN of the KMS key that's used for encryption.

        • HealthCheckConfiguration — (map)

          The settings for the health check that App Runner performs to monitor the health of this service.

          • Protocol — (String)

            The IP protocol that App Runner uses to perform health checks for your service.

            If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.

            Default: TCP

            Possible values include:
            • "TCP"
            • "HTTP"
          • Path — (String)

            The URL that health check requests are sent to.

            Path is only applicable when you set Protocol to HTTP.

            Default: "/"

          • Interval — (Integer)

            The time interval, in seconds, between health checks.

            Default: 5

          • Timeout — (Integer)

            The time, in seconds, to wait for a health check response before deciding it failed.

            Default: 2

          • HealthyThreshold — (Integer)

            The number of consecutive checks that must succeed before App Runner decides that the service is healthy.

            Default: 3

          • UnhealthyThreshold — (Integer)

            The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

            Default: 3

        • AutoScalingConfigurationSummaryrequired — (map)

          Summary information for the App Runner automatic scaling configuration resource that's associated with this service.

          • AutoScalingConfigurationArn — (String)

            The Amazon Resource Name (ARN) of this auto scaling configuration.

          • AutoScalingConfigurationName — (String)

            The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.

          • AutoScalingConfigurationRevision — (Integer)

            The revision of this auto scaling configuration. It's unique among all the active configurations ("Status": "ACTIVE") with the same AutoScalingConfigurationName.

      • OperationId — (String)

        The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track the operation's progress.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.