Class: AWS.AppRunner

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 Amazon Web Services Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.

    Note: Prior to the release of Auto scale configuration enhancements, the name DefaultConfiguration was reserved. This restriction is no longer in place. You can now manage DefaultConfiguration the same way you manage your custom auto scaling configurations. This means you can do the following with the DefaultConfiguration that App Runner provides:

    • Create new revisions of the DefaultConfiguration.
    • Delete the revisions of the DefaultConfiguration.
    • Delete the auto scaling configuration for which the App Runner DefaultConfiguration was created.
    • If you delete the auto scaling configuration you can create another custom auto scaling configuration with the same DefaultConfiguration name. The original DefaultConfiguration resource provided by App Runner remains in your account unless you make changes to it.
  • 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 AutoScalingConfigurationName. 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.

      • HasAssociatedService — (Boolean)

        Indicates if this auto scaling configuration has an App Runner service associated with it. A value of true indicates one or more services are associated. A value of false indicates no services are associated.

      • IsDefault — (Boolean)

        Indicates if this auto scaling configuration should be used as the default for a new App Runner service that does not have an auto scaling configuration ARN specified during creation. Each account can have only one default AutoScalingConfiguration per region. The default AutoScalingConfiguration can be any revision under the same AutoScalingConfigurationName.

Returns:

• (AWS.Request) —

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

var params = {
  ConnectionName: 'STRING_VALUE', /* required */
  ProviderType: GITHUB | BITBUCKET, /* 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 Amazon Web Services account in the Amazon Web Services Region.

  • ProviderType — (String)

    The source repository provider.

    Possible values include:
    • "GITHUB"
    • "BITBUCKET"
  • 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"
        • "BITBUCKET"
      • 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.

var params = {
  ObservabilityConfigurationName: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TraceConfiguration: {
    Vendor: AWSXRAY /* required */
  }
};
apprunner.createObservabilityConfiguration(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: {}) —
  • ObservabilityConfigurationName — (String)

    A name for the observability configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.

    Note: The name DefaultConfiguration is reserved. You can't use it to create a new observability configuration, and you can't create a revision of it. When you want to use your own observability configuration for your App Runner service, create a configuration with a different name, and then provide it when you create or update your service.
  • TraceConfiguration — (map)

    The configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing.

    • Vendor — required — (String)

      The implementation provider chosen for tracing App Runner services.

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

    A list of metadata items that you can associate with your observability 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:

    • ObservabilityConfiguration — (map)

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

      • ObservabilityConfigurationArn — (String)

        The Amazon Resource Name (ARN) of this observability configuration.

      • ObservabilityConfigurationName — (String)

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

      • TraceConfiguration — (map)

        The configuration of the tracing feature within this observability configuration. If not specified, tracing isn't enabled.

        • Vendor — required — (String)

          The implementation provider chosen for tracing App Runner services.

          Possible values include:
          • "AWSXRAY"
      • ObservabilityConfigurationRevision — (Integer)

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

      • Latest — (Boolean)

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

      • Status — (String)

        The current state of the observability 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"
      • CreatedAt — (Date)

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

      • DeletedAt — (Date)

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

Returns:

• (AWS.Request) —

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

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 | NODEJS_14 | CORRETTO_8 | CORRETTO_11 | NODEJS_16 | GO_1 | DOTNET_6 | PHP_81 | RUBY_31 | PYTHON_311 | NODEJS_18, /* required */
          BuildCommand: 'STRING_VALUE',
          Port: 'STRING_VALUE',
          RuntimeEnvironmentSecrets: {
            '<RuntimeEnvironmentSecretsName>': 'STRING_VALUE',
            /* '<RuntimeEnvironmentSecretsName>': ... */
          },
          RuntimeEnvironmentVariables: {
            '<RuntimeEnvironmentVariablesKey>': 'STRING_VALUE',
            /* '<RuntimeEnvironmentVariablesKey>': ... */
          },
          StartCommand: 'STRING_VALUE'
        }
      },
      SourceDirectory: 'STRING_VALUE'
    },
    ImageRepository: {
      ImageIdentifier: 'STRING_VALUE', /* required */
      ImageRepositoryType: ECR | ECR_PUBLIC, /* required */
      ImageConfiguration: {
        Port: 'STRING_VALUE',
        RuntimeEnvironmentSecrets: {
          '<RuntimeEnvironmentSecretsName>': 'STRING_VALUE',
          /* '<RuntimeEnvironmentSecretsName>': ... */
        },
        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'
  },
  NetworkConfiguration: {
    EgressConfiguration: {
      EgressType: DEFAULT | VPC,
      VpcConnectorArn: 'STRING_VALUE'
    },
    IngressConfiguration: {
      IsPubliclyAccessible: true || false
    },
    IpAddressType: IPV4 | DUAL_STACK
  },
  ObservabilityConfiguration: {
    ObservabilityEnabled: true || false, /* required */
    ObservabilityConfigurationArn: '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 App Runner service. It must be unique across all the running App Runner services in your Amazon Web Services account in the Amazon Web Services Region.

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

      • RepositoryUrl — required — (String)

        The location of the repository that contains the source code.

      • SourceCodeVersion — required — (map)

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

        • Type — required — (String)

          The type of version identifier.

          For a git-based repository, branches represent versions.

          Possible values include:
          • "BRANCH"
        • Value — required — (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.

        Note: CodeConfiguration is required only for CreateService request.
        • ConfigurationSource — required — (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).

          • Runtime — required — (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"
            • "NODEJS_14"
            • "CORRETTO_8"
            • "CORRETTO_11"
            • "NODEJS_16"
            • "GO_1"
            • "DOTNET_6"
            • "PHP_81"
            • "RUBY_31"
            • "PYTHON_311"
            • "NODEJS_18"
          • 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.

          • RuntimeEnvironmentSecrets — (map<String>)

            An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

            Note:

            • If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services Region as the service that you're launching, you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.
            • Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported.
      • SourceDirectory — (String)

        The path of the directory that stores source code and configuration files. The build and start commands also execute from here. The path is absolute from root and, if not specified, defaults to the repository root.

    • ImageRepository — (map)

      The description of a source image repository.

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

      • ImageIdentifier — required — (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.

        • 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

        • RuntimeEnvironmentSecrets — (map<String>)

          An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

          Note:

          • If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services Region as the service that you're launching, you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.
          • Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported.
      • ImageRepositoryType — required — (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 (including any source code commit or new image version) starts a deployment.

      Default: App Runner sets to false for a source image that uses an ECR Public repository or an ECR repository that's in an Amazon Web Services account other than the one that the service is in. App Runner sets to true in all other cases (which currently include a source code repository or a source image using a same-account ECR repository).

    • 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 your 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 Amazon Web Services APIs.

  • Tags — (Array<map>)

    An optional list of metadata items that you can associate with the App Runner 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 Amazon Web Services managed key.

    • KmsKey — required — (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 the App Runner 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: 1

    • UnhealthyThreshold — (Integer)

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

      Default: 5

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

    Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3

    Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability

  • NetworkConfiguration — (map)

    Configuration settings related to network traffic of the web application that the App Runner service runs.

    • EgressConfiguration — (map)

      Network configuration settings for outbound message traffic.

      • EgressType — (String)

        The type of egress configuration.

        Set to DEFAULT for access to resources hosted on public networks.

        Set to VPC to associate your service to a custom VPC specified by VpcConnectorArn.

        Possible values include:
        • "DEFAULT"
        • "VPC"
      • VpcConnectorArn — (String)

        The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner service. Only valid when EgressType = VPC.

    • IngressConfiguration — (map)

      Network configuration settings for inbound message traffic.

      • IsPubliclyAccessible — (Boolean)

        Specifies whether your App Runner service is publicly accessible. To make the service publicly accessible set it to True. To make the service privately accessible, from only within an Amazon VPC set it to False.

    • IpAddressType — (String)

      App Runner provides you with the option to choose between Internet Protocol version 4 (IPv4) and dual stack (IPv4 and IPv6) for your incoming public network configuration. This is an optional parameter. If you do not specify an IpAddressType, it defaults to select IPv4.

      Note: Currently, App Runner supports dual stack for only Public endpoint. Only IPv4 is supported for Private endpoint. If you update a service that's using dual-stack Public endpoint to a Private endpoint, your App Runner service will default to support only IPv4 for Private endpoint and fail to receive traffic originating from IPv6 endpoint.
      Possible values include:
      • "IPV4"
      • "DUAL_STACK"
  • ObservabilityConfiguration — (map)

    The observability configuration of your service.

    • ObservabilityEnabled — required — (Boolean)

      When true, an observability configuration resource is associated with the service, and an ObservabilityConfigurationArn is specified.

    • ObservabilityConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when ObservabilityEnabled is true.

      Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3

      Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing

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.

      • ServiceName — required — (String)

        The customer-provided service name.

      • ServiceId — required — (String)

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

      • ServiceArn — required — (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 — required — (Date)

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

      • UpdatedAt — required — (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.

      • Status — required — (String)

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

        • CREATE_FAILED – The service failed to create. The failed service isn't usable, and still counts towards your service quota. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using UpdateService.

        • 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"
      • SourceConfiguration — required — (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).

          • RepositoryUrl — required — (String)

            The location of the repository that contains the source code.

          • SourceCodeVersion — required — (map)

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

            • Type — required — (String)

              The type of version identifier.

              For a git-based repository, branches represent versions.

              Possible values include:
              • "BRANCH"
            • Value — required — (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.

            Note: CodeConfiguration is required only for CreateService request.
            • ConfigurationSource — required — (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).

              • Runtime — required — (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"
                • "NODEJS_14"
                • "CORRETTO_8"
                • "CORRETTO_11"
                • "NODEJS_16"
                • "GO_1"
                • "DOTNET_6"
                • "PHP_81"
                • "RUBY_31"
                • "PYTHON_311"
                • "NODEJS_18"
              • 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.

              • RuntimeEnvironmentSecrets — (map<String>)

                An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

                Note:

                • If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services Region as the service that you're launching, you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.
                • Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported.
          • SourceDirectory — (String)

            The path of the directory that stores source code and configuration files. The build and start commands also execute from here. The path is absolute from root and, if not specified, defaults to the repository root.

        • ImageRepository — (map)

          The description of a source image repository.

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

          • ImageIdentifier — required — (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.

            • 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

            • RuntimeEnvironmentSecrets — (map<String>)

              An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

              Note:

              • If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services Region as the service that you're launching, you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.
              • Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported.
          • ImageRepositoryType — required — (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 (including any source code commit or new image version) starts a deployment.

          Default: App Runner sets to false for a source image that uses an ECR Public repository or an ECR repository that's in an Amazon Web Services account other than the one that the service is in. App Runner sets to true in all other cases (which currently include a source code repository or a source image using a same-account ECR repository).

        • 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 — required — (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 Amazon Web Services 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 Amazon Web Services managed key.

        • KmsKey — required — (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: 1

        • UnhealthyThreshold — (Integer)

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

          Default: 5

      • AutoScalingConfigurationSummary — required — (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.

        • 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"
        • CreatedAt — (Date)

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

        • HasAssociatedService — (Boolean)

          Indicates if this auto scaling configuration has an App Runner service associated with it. A value of true indicates one or more services are associated. A value of false indicates no services are associated.

        • IsDefault — (Boolean)

          Indicates if this auto scaling configuration should be used as the default for a new App Runner service that does not have an auto scaling configuration ARN specified during creation. Each account can have only one default AutoScalingConfiguration per region. The default AutoScalingConfiguration can be any revision under the same AutoScalingConfigurationName.

      • NetworkConfiguration — required — (map)

        Configuration settings related to network traffic of the web application that this service runs.

        • EgressConfiguration — (map)

          Network configuration settings for outbound message traffic.

          • EgressType — (String)

            The type of egress configuration.

            Set to DEFAULT for access to resources hosted on public networks.

            Set to VPC to associate your service to a custom VPC specified by VpcConnectorArn.

            Possible values include:
            • "DEFAULT"
            • "VPC"
          • VpcConnectorArn — (String)

            The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner service. Only valid when EgressType = VPC.

        • IngressConfiguration — (map)

          Network configuration settings for inbound message traffic.

          • IsPubliclyAccessible — (Boolean)

            Specifies whether your App Runner service is publicly accessible. To make the service publicly accessible set it to True. To make the service privately accessible, from only within an Amazon VPC set it to False.

        • IpAddressType — (String)

          App Runner provides you with the option to choose between Internet Protocol version 4 (IPv4) and dual stack (IPv4 and IPv6) for your incoming public network configuration. This is an optional parameter. If you do not specify an IpAddressType, it defaults to select IPv4.

          Note: Currently, App Runner supports dual stack for only Public endpoint. Only IPv4 is supported for Private endpoint. If you update a service that's using dual-stack Public endpoint to a Private endpoint, your App Runner service will default to support only IPv4 for Private endpoint and fail to receive traffic originating from IPv6 endpoint.
          Possible values include:
          • "IPV4"
          • "DUAL_STACK"
      • ObservabilityConfiguration — (map)

        The observability configuration of this service.

        • ObservabilityEnabled — required — (Boolean)

          When true, an observability configuration resource is associated with the service, and an ObservabilityConfigurationArn is specified.

        • ObservabilityConfigurationArn — (String)

          The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when ObservabilityEnabled is true.

          Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3

          Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing

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

var params = {
  Subnets: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  VpcConnectorName: 'STRING_VALUE', /* required */
  SecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
apprunner.createVpcConnector(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: {}) —
  • VpcConnectorName — (String)

    A name for the VPC connector.

  • Subnets — (Array<String>)

    A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

    Note: App Runner currently only provides support for IPv4.
  • SecurityGroups — (Array<String>)

    A list of IDs of security groups that App Runner should use for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

  • Tags — (Array<map>)

    A list of metadata items that you can associate with your VPC connector 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:

    • VpcConnector — (map)

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

      • VpcConnectorName — (String)

        The customer-provided VPC connector name.

      • VpcConnectorArn — (String)

        The Amazon Resource Name (ARN) of this VPC connector.

      • VpcConnectorRevision — (Integer)

        The revision of this VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.

        Note: At this time, App Runner supports only one revision per name.
      • Subnets — (Array<String>)

        A list of IDs of subnets that App Runner uses for your service. All IDs are of subnets of a single Amazon VPC.

      • SecurityGroups — (Array<String>)

        A list of IDs of security groups that App Runner uses for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

      • Status — (String)

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

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
      • CreatedAt — (Date)

        The time when the VPC connector was created. It's in Unix time stamp format.

      • DeletedAt — (Date)

        The time when the VPC connector was deleted. It's in Unix time stamp format.

Returns:

• (AWS.Request) —

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

var params = {
  IngressVpcConfiguration: { /* required */
    VpcEndpointId: 'STRING_VALUE',
    VpcId: 'STRING_VALUE'
  },
  ServiceArn: 'STRING_VALUE', /* required */
  VpcIngressConnectionName: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
apprunner.createVpcIngressConnection(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) for this App Runner service that is used to create the VPC Ingress Connection resource.

  • VpcIngressConnectionName — (String)

    A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your Amazon Web Services account in the Amazon Web Services Region.

  • IngressVpcConfiguration — (map)

    Specifications for the customer’s Amazon VPC and the related Amazon Web Services PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource.

    • VpcId — (String)

      The ID of the VPC that is used for the VPC endpoint.

    • VpcEndpointId — (String)

      The ID of the VPC endpoint that your App Runner service connects to.

  • Tags — (Array<map>)

    An optional list of metadata items that you can associate with the VPC Ingress 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:

    • VpcIngressConnection — (map)

      A description of the App Runner VPC Ingress Connection resource that's created by this request.

      • VpcIngressConnectionArn — (String)

        The Amazon Resource Name (ARN) of the VPC Ingress Connection.

      • VpcIngressConnectionName — (String)

        The customer-provided VPC Ingress Connection name.

      • ServiceArn — (String)

        The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection.

      • Status — (String)

        The current status of the VPC Ingress Connection. The VPC Ingress Connection displays one of the following statuses: AVAILABLE, PENDING_CREATION, PENDING_UPDATE, PENDING_DELETION,FAILED_CREATION, FAILED_UPDATE, FAILED_DELETION, and DELETED..

        Possible values include:
        • "AVAILABLE"
        • "PENDING_CREATION"
        • "PENDING_UPDATE"
        • "PENDING_DELETION"
        • "FAILED_CREATION"
        • "FAILED_UPDATE"
        • "FAILED_DELETION"
        • "DELETED"
      • AccountId — (String)

        The Account Id you use to create the VPC Ingress Connection resource.

      • DomainName — (String)

        The domain name associated with the VPC Ingress Connection resource.

      • IngressVpcConfiguration — (map)

        Specifications for the customer’s VPC and related PrivateLink VPC endpoint that are used to associate with the VPC Ingress Connection resource.

        • VpcId — (String)

          The ID of the VPC that is used for the VPC endpoint.

        • VpcEndpointId — (String)

          The ID of the VPC endpoint that your App Runner service connects to.

      • CreatedAt — (Date)

        The time when the VPC Ingress Connection was created. It's in the Unix time stamp format.

        • Type: Timestamp

        • Required: Yes

      • DeletedAt — (Date)

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

        • Type: Timestamp

        • Required: No

Returns:

• (AWS.Request) —

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

var params = {
  AutoScalingConfigurationArn: 'STRING_VALUE', /* required */
  DeleteAllRevisions: true || false
};
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.

  • DeleteAllRevisions — (Boolean)

    Set to true to delete all of the revisions associated with the AutoScalingConfigurationArn parameter value.

    When DeleteAllRevisions is set to true, the only valid value for the Amazon Resource Name (ARN) is a partial ARN ending with: .../name.

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

      • HasAssociatedService — (Boolean)

        Indicates if this auto scaling configuration has an App Runner service associated with it. A value of true indicates one or more services are associated. A value of false indicates no services are associated.

      • IsDefault — (Boolean)

        Indicates if this auto scaling configuration should be used as the default for a new App Runner service that does not have an auto scaling configuration ARN specified during creation. Each account can have only one default AutoScalingConfiguration per region. The default AutoScalingConfiguration can be any revision under the same AutoScalingConfigurationName.

Returns:

• (AWS.Request) —

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

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"
        • "BITBUCKET"
      • 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.

var params = {
  ObservabilityConfigurationArn: 'STRING_VALUE' /* required */
};
apprunner.deleteObservabilityConfiguration(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: {}) —
  • ObservabilityConfigurationArn — (String)

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

    The ARN can be a full observability configuration ARN, or a partial ARN ending with either .../name or .../name/revision . If a revision isn't specified, the latest active revision is deleted.

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:

    • ObservabilityConfiguration — (map)

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

      • ObservabilityConfigurationArn — (String)

        The Amazon Resource Name (ARN) of this observability configuration.

      • ObservabilityConfigurationName — (String)

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

      • TraceConfiguration — (map)

        The configuration of the tracing feature within this observability configuration. If not specified, tracing isn't enabled.

        • Vendor — required — (String)

          The implementation provider chosen for tracing App Runner services.

          Possible values include:
          • "AWSXRAY"
      • ObservabilityConfigurationRevision — (Integer)

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

      • Latest — (Boolean)

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

      • Status — (String)

        The current state of the observability 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"
      • CreatedAt — (Date)

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

      • DeletedAt — (Date)

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

Returns:

• (AWS.Request) —

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

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.

      • ServiceName — required — (String)

        The customer-provided service name.

      • ServiceId — required — (String)

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

      • ServiceArn — required — (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 — required — (Date)

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

      • UpdatedAt — required — (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.

      • Status — required — (String)

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

        • CREATE_FAILED – The service failed to create. The failed service isn't usable, and still counts towards your service quota. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using UpdateService.

        • 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"
      • SourceConfiguration — required — (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).

          • RepositoryUrl — required — (String)

            The location of the repository that contains the source code.

          • SourceCodeVersion — required — (map)

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

            • Type — required — (String)

              The type of version identifier.

              For a git-based repository, branches represent versions.

              Possible values include:
              • "BRANCH"
            • Value — required — (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.

            Note: CodeConfiguration is required only for CreateService request.
            • ConfigurationSource — required — (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).

              • Runtime — required — (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"
                • "NODEJS_14"
                • "CORRETTO_8"
                • "CORRETTO_11"
                • "NODEJS_16"
                • "GO_1"
                • "DOTNET_6"
                • "PHP_81"
                • "RUBY_31"
                • "PYTHON_311"
                • "NODEJS_18"
              • 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.

              • RuntimeEnvironmentSecrets — (map<String>)

                An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

                Note:

                • If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services Region as the service that you're launching, you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.
                • Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported.
          • SourceDirectory — (String)

            The path of the directory that stores source code and configuration files. The build and start commands also execute from here. The path is absolute from root and, if not specified, defaults to the repository root.

        • ImageRepository — (map)

          The description of a source image repository.

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

          • ImageIdentifier — required — (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.

            • 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

            • RuntimeEnvironmentSecrets — (map<String>)

              An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

              Note:

              • If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services Region as the service that you're launching, you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.
              • Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported.
          • ImageRepositoryType — required — (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 (including any source code commit or new image version) starts a deployment.

          Default: App Runner sets to false for a source image that uses an ECR Public repository or an ECR repository that's in an Amazon Web Services account other than the one that the service is in. App Runner sets to true in all other cases (which currently include a source code repository or a source image using a same-account ECR repository).

        • 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 — required — (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 Amazon Web Services 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 Amazon Web Services managed key.

        • KmsKey — required — (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: 1

        • UnhealthyThreshold — (Integer)

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

          Default: 5

      • AutoScalingConfigurationSummary — required — (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.

        • 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"
        • CreatedAt — (Date)

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

        • HasAssociatedService — (Boolean)

          Indicates if this auto scaling configuration has an App Runner service associated with it. A value of true indicates one or more services are associated. A value of false indicates no services are associated.

        • IsDefault — (Boolean)

          Indicates if this auto scaling configuration should be used as the default for a new App Runner service that does not have an auto scaling configuration ARN specified during creation. Each account can have only one default AutoScalingConfiguration per region. The default AutoScalingConfiguration can be any revision under the same AutoScalingConfigurationName.

      • NetworkConfiguration — required — (map)

        Configuration settings related to network traffic of the web application that this service runs.

        • EgressConfiguration — (map)

          Network configuration settings for outbound message traffic.

          • EgressType — (String)

            The type of egress configuration.

            Set to DEFAULT for access to resources hosted on public networks.

            Set to VPC to associate your service to a custom VPC specified by VpcConnectorArn.

            Possible values include:
            • "DEFAULT"
            • "VPC"
          • VpcConnectorArn — (String)

            The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner service. Only valid when EgressType = VPC.

        • IngressConfiguration — (map)

          Network configuration settings for inbound message traffic.

          • IsPubliclyAccessible — (Boolean)

            Specifies whether your App Runner service is publicly accessible. To make the service publicly accessible set it to True. To make the service privately accessible, from only within an Amazon VPC set it to False.

        • IpAddressType — (String)

          App Runner provides you with the option to choose between Internet Protocol version 4 (IPv4) and dual stack (IPv4 and IPv6) for your incoming public network configuration. This is an optional parameter. If you do not specify an IpAddressType, it defaults to select IPv4.

          Note: Currently, App Runner supports dual stack for only Public endpoint. Only IPv4 is supported for Private endpoint. If you update a service that's using dual-stack Public endpoint to a Private endpoint, your App Runner service will default to support only IPv4 for Private endpoint and fail to receive traffic originating from IPv6 endpoint.
          Possible values include:
          • "IPV4"
          • "DUAL_STACK"
      • ObservabilityConfiguration — (map)

        The observability configuration of this service.

        • ObservabilityEnabled — required — (Boolean)

          When true, an observability configuration resource is associated with the service, and an ObservabilityConfigurationArn is specified.

        • ObservabilityConfigurationArn — (String)

          The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when ObservabilityEnabled is true.

          Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3

          Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing

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

var params = {
  VpcConnectorArn: 'STRING_VALUE' /* required */
};
apprunner.deleteVpcConnector(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: {}) —
  • VpcConnectorArn — (String)

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

    The ARN must be a full VPC connector ARN.

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:

    • VpcConnector — (map)

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

      • VpcConnectorName — (String)

        The customer-provided VPC connector name.

      • VpcConnectorArn — (String)

        The Amazon Resource Name (ARN) of this VPC connector.

      • VpcConnectorRevision — (Integer)

        The revision of this VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.

        Note: At this time, App Runner supports only one revision per name.
      • Subnets — (Array<String>)

        A list of IDs of subnets that App Runner uses for your service. All IDs are of subnets of a single Amazon VPC.

      • SecurityGroups — (Array<String>)

        A list of IDs of security groups that App Runner uses for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

      • Status — (String)

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

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
      • CreatedAt — (Date)

        The time when the VPC connector was created. It's in Unix time stamp format.

      • DeletedAt — (Date)

        The time when the VPC connector was deleted. It's in Unix time stamp format.

Returns:

• (AWS.Request) —

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

var params = {
  VpcIngressConnectionArn: 'STRING_VALUE' /* required */
};
apprunner.deleteVpcIngressConnection(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: {}) —
  • VpcIngressConnectionArn — (String)

    The Amazon Resource Name (ARN) of the App Runner VPC Ingress 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:

    • VpcIngressConnection — (map)

      A description of the App Runner VPC Ingress Connection that this request just deleted.

      • VpcIngressConnectionArn — (String)

        The Amazon Resource Name (ARN) of the VPC Ingress Connection.

      • VpcIngressConnectionName — (String)

        The customer-provided VPC Ingress Connection name.

      • ServiceArn — (String)

        The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection.

      • Status — (String)

        The current status of the VPC Ingress Connection. The VPC Ingress Connection displays one of the following statuses: AVAILABLE, PENDING_CREATION, PENDING_UPDATE, PENDING_DELETION,FAILED_CREATION, FAILED_UPDATE, FAILED_DELETION, and DELETED..

        Possible values include:
        • "AVAILABLE"
        • "PENDING_CREATION"
        • "PENDING_UPDATE"
        • "PENDING_DELETION"
        • "FAILED_CREATION"
        • "FAILED_UPDATE"
        • "FAILED_DELETION"
        • "DELETED"
      • AccountId — (String)

        The Account Id you use to create the VPC Ingress Connection resource.

      • DomainName — (String)

        The domain name associated with the VPC Ingress Connection resource.

      • IngressVpcConfiguration — (map)

        Specifications for the customer’s VPC and related PrivateLink VPC endpoint that are used to associate with the VPC Ingress Connection resource.

        • VpcId — (String)

          The ID of the VPC that is used for the VPC endpoint.

        • VpcEndpointId — (String)

          The ID of the VPC endpoint that your App Runner service connects to.

      • CreatedAt — (Date)

        The time when the VPC Ingress Connection was created. It's in the Unix time stamp format.

        • Type: Timestamp

        • Required: Yes

      • DeletedAt — (Date)

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

        • Type: Timestamp

        • Required: No

Returns:

• (AWS.Request) —

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

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

      • HasAssociatedService — (Boolean)

        Indicates if this auto scaling configuration has an App Runner service associated with it. A value of true indicates one or more services are associated. A value of false indicates no services are associated.

      • IsDefault — (Boolean)

        Indicates if this auto scaling configuration should be used as the default for a new App Runner service that does not have an auto scaling configuration ARN specified during creation. Each account can have only one default AutoScalingConfiguration per region. The default AutoScalingConfiguration can be any revision under the same AutoScalingConfigurationName.

Returns:

• (AWS.Request) —

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

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.

      • DomainName — required — (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).

      • EnableWWWSubdomain — required — (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"
      • Status — required — (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"
    • VpcDNSTargets — (Array<map>)

      DNS Target records for the custom domains of this Amazon VPC.

      • VpcIngressConnectionArn — (String)

        The Amazon Resource Name (ARN) of the VPC Ingress Connection that is associated with your service.

      • VpcId — (String)

        The ID of the Amazon VPC that is associated with the custom domain name of the target DNS.

      • DomainName — (String)

        The domain name of your target DNS that is associated with the Amazon VPC.

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

var params = {
  ObservabilityConfigurationArn: 'STRING_VALUE' /* required */
};
apprunner.describeObservabilityConfiguration(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: {}) —
  • ObservabilityConfigurationArn — (String)

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

    The ARN can be a full observability configuration ARN, or a partial ARN ending with either .../name or .../name/revision . If a revision isn't specified, the latest active revision is described.

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:

    • ObservabilityConfiguration — (map)

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

      • ObservabilityConfigurationArn — (String)

        The Amazon Resource Name (ARN) of this observability configuration.

      • ObservabilityConfigurationName — (String)

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

      • TraceConfiguration — (map)

        The configuration of the tracing feature within this observability configuration. If not specified, tracing isn't enabled.

        • Vendor — required — (String)

          The implementation provider chosen for tracing App Runner services.

          Possible values include:
          • "AWSXRAY"
      • ObservabilityConfigurationRevision — (Integer)

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

      • Latest — (Boolean)

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

      • Status — (String)

        The current state of the observability 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"
      • CreatedAt — (Date)

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

      • DeletedAt — (Date)

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

Returns:

• (AWS.Request) —

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

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.

      • ServiceName — required — (String)

        The customer-provided service name.

      • ServiceId — required — (String)

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

      • ServiceArn — required — (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 — required — (Date)

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

      • UpdatedAt — required — (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.

      • Status — required — (String)

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

        • CREATE_FAILED – The service failed to create. The failed service isn't usable, and still counts towards your service quota. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using UpdateService.

        • 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"
      • SourceConfiguration — required — (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).

          • RepositoryUrl — required — (String)

            The location of the repository that contains the source code.

          • SourceCodeVersion — required — (map)

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

            • Type — required — (String)

              The type of version identifier.

              For a git-based repository, branches represent versions.

              Possible values include:
              • "BRANCH"
            • Value — required — (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.

            Note: CodeConfiguration is required only for CreateService request.
            • ConfigurationSource — required — (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).

              • Runtime — required — (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"
                • "NODEJS_14"
                • "CORRETTO_8"
                • "CORRETTO_11"
                • "NODEJS_16"
                • "GO_1"
                • "DOTNET_6"
                • "PHP_81"
                • "RUBY_31"
                • "PYTHON_311"
                • "NODEJS_18"
              • 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.

              • RuntimeEnvironmentSecrets — (map<String>)

                An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

                Note:

                • If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services Region as the service that you're launching, you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.
                • Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported.
          • SourceDirectory — (String)

            The path of the directory that stores source code and configuration files. The build and start commands also execute from here. The path is absolute from root and, if not specified, defaults to the repository root.

        • ImageRepository — (map)

          The description of a source image repository.

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

          • ImageIdentifier — required — (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.

            • 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

            • RuntimeEnvironmentSecrets — (map<String>)

              An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

              Note:

              • If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services Region as the service that you're launching, you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.
              • Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported.
          • ImageRepositoryType — required — (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 (including any source code commit or new image version) starts a deployment.

          Default: App Runner sets to false for a source image that uses an ECR Public repository or an ECR repository that's in an Amazon Web Services account other than the one that the service is in. App Runner sets to true in all other cases (which currently include a source code repository or a source image using a same-account ECR repository).

        • 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 — required — (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 Amazon Web Services 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 Amazon Web Services managed key.

        • KmsKey — required — (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: 1

        • UnhealthyThreshold — (Integer)

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

          Default: 5

      • AutoScalingConfigurationSummary — required — (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.

        • 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"
        • CreatedAt — (Date)

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

        • HasAssociatedService — (Boolean)

          Indicates if this auto scaling configuration has an App Runner service associated with it. A value of true indicates one or more services are associated. A value of false indicates no services are associated.

        • IsDefault — (Boolean)

          Indicates if this auto scaling configuration should be used as the default for a new App Runner service that does not have an auto scaling configuration ARN specified during creation. Each account can have only one default AutoScalingConfiguration per region. The default AutoScalingConfiguration can be any revision under the same AutoScalingConfigurationName.

      • NetworkConfiguration — required — (map)

        Configuration settings related to network traffic of the web application that this service runs.

        • EgressConfiguration — (map)

          Network configuration settings for outbound message traffic.

          • EgressType — (String)

            The type of egress configuration.

            Set to DEFAULT for access to resources hosted on public networks.

            Set to VPC to associate your service to a custom VPC specified by VpcConnectorArn.

            Possible values include:
            • "DEFAULT"
            • "VPC"
          • VpcConnectorArn — (String)

            The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner service. Only valid when EgressType = VPC.

        • IngressConfiguration — (map)

          Network configuration settings for inbound message traffic.

          • IsPubliclyAccessible — (Boolean)

            Specifies whether your App Runner service is publicly accessible. To make the service publicly accessible set it to True. To make the service privately accessible, from only within an Amazon VPC set it to False.

        • IpAddressType — (String)

          App Runner provides you with the option to choose between Internet Protocol version 4 (IPv4) and dual stack (IPv4 and IPv6) for your incoming public network configuration. This is an optional parameter. If you do not specify an IpAddressType, it defaults to select IPv4.

          Note: Currently, App Runner supports dual stack for only Public endpoint. Only IPv4 is supported for Private endpoint. If you update a service that's using dual-stack Public endpoint to a Private endpoint, your App Runner service will default to support only IPv4 for Private endpoint and fail to receive traffic originating from IPv6 endpoint.
          Possible values include:
          • "IPV4"
          • "DUAL_STACK"
      • ObservabilityConfiguration — (map)

        The observability configuration of this service.

        • ObservabilityEnabled — required — (Boolean)

          When true, an observability configuration resource is associated with the service, and an ObservabilityConfigurationArn is specified.

        • ObservabilityConfigurationArn — (String)

          The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when ObservabilityEnabled is true.

          Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3

          Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing

Returns:

• (AWS.Request) —

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

var params = {
  VpcConnectorArn: 'STRING_VALUE' /* required */
};
apprunner.describeVpcConnector(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: {}) —
  • VpcConnectorArn — (String)

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

    The ARN must be a full VPC connector ARN.

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:

    • VpcConnector — (map)

      A description of the App Runner VPC connector that you specified in this request.

      • VpcConnectorName — (String)

        The customer-provided VPC connector name.

      • VpcConnectorArn — (String)

        The Amazon Resource Name (ARN) of this VPC connector.

      • VpcConnectorRevision — (Integer)

        The revision of this VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.

        Note: At this time, App Runner supports only one revision per name.
      • Subnets — (Array<String>)

        A list of IDs of subnets that App Runner uses for your service. All IDs are of subnets of a single Amazon VPC.

      • SecurityGroups — (Array<String>)

        A list of IDs of security groups that App Runner uses for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

      • Status — (String)

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

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
      • CreatedAt — (Date)

        The time when the VPC connector was created. It's in Unix time stamp format.

      • DeletedAt — (Date)

        The time when the VPC connector was deleted. It's in Unix time stamp format.

Returns:

• (AWS.Request) —

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

var params = {
  VpcIngressConnectionArn: 'STRING_VALUE' /* required */
};
apprunner.describeVpcIngressConnection(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: {}) —
  • VpcIngressConnectionArn — (String)

    The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection 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:

    • VpcIngressConnection — (map)

      A description of the App Runner VPC Ingress Connection that you specified in this request.

      • VpcIngressConnectionArn — (String)

        The Amazon Resource Name (ARN) of the VPC Ingress Connection.

      • VpcIngressConnectionName — (String)

        The customer-provided VPC Ingress Connection name.

      • ServiceArn — (String)

        The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection.

      • Status — (String)

        The current status of the VPC Ingress Connection. The VPC Ingress Connection displays one of the following statuses: AVAILABLE, PENDING_CREATION, PENDING_UPDATE, PENDING_DELETION,FAILED_CREATION, FAILED_UPDATE, FAILED_DELETION, and DELETED..

        Possible values include:
        • "AVAILABLE"
        • "PENDING_CREATION"
        • "PENDING_UPDATE"
        • "PENDING_DELETION"
        • "FAILED_CREATION"
        • "FAILED_UPDATE"
        • "FAILED_DELETION"
        • "DELETED"
      • AccountId — (String)

        The Account Id you use to create the VPC Ingress Connection resource.

      • DomainName — (String)

        The domain name associated with the VPC Ingress Connection resource.

      • IngressVpcConfiguration — (map)

        Specifications for the customer’s VPC and related PrivateLink VPC endpoint that are used to associate with the VPC Ingress Connection resource.

        • VpcId — (String)

          The ID of the VPC that is used for the VPC endpoint.

        • VpcEndpointId — (String)

          The ID of the VPC endpoint that your App Runner service connects to.

      • CreatedAt — (Date)

        The time when the VPC Ingress Connection was created. It's in the Unix time stamp format.

        • Type: Timestamp

        • Required: Yes

      • DeletedAt — (Date)

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

        • Type: Timestamp

        • Required: No

Returns:

• (AWS.Request) —

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

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.

      • DomainName — required — (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).

      • EnableWWWSubdomain — required — (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"
      • Status — required — (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"
    • VpcDNSTargets — (Array<map>)

      DNS Target records for the custom domains of this Amazon VPC.

      • VpcIngressConnectionArn — (String)

        The Amazon Resource Name (ARN) of the VPC Ingress Connection that is associated with your service.

      • VpcId — (String)

        The ID of the Amazon VPC that is associated with the custom domain name of the target DNS.

      • DomainName — (String)

        The domain name of your target DNS that is associated with the Amazon VPC.

Returns:

• (AWS.Request) —

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

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

  • LatestOnly — (Boolean)

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

    Set to false to list all revisions for each requested configuration name.

    Default: true

  • MaxResults — (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.

      • 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"
      • CreatedAt — (Date)

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

      • HasAssociatedService — (Boolean)

        Indicates if this auto scaling configuration has an App Runner service associated with it. A value of true indicates one or more services are associated. A value of false indicates no services are associated.

      • IsDefault — (Boolean)

        Indicates if this auto scaling configuration should be used as the default for a new App Runner service that does not have an auto scaling configuration ARN specified during creation. Each account can have only one default AutoScalingConfiguration per region. The default AutoScalingConfiguration can be any revision under 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.

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"
        • "BITBUCKET"
      • 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.

var params = {
  LatestOnly: true || false,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ObservabilityConfigurationName: 'STRING_VALUE'
};
apprunner.listObservabilityConfigurations(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: {}) —
  • ObservabilityConfigurationName — (String)

    The name of the App Runner observability configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified, App Runner returns revisions of all active configurations.

  • LatestOnly — (Boolean)

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

    Set to false to list all revisions for each requested configuration name.

    Default: true

  • MaxResults — (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:

    • ObservabilityConfigurationSummaryList — (Array<map>)

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

      • ObservabilityConfigurationArn — (String)

        The Amazon Resource Name (ARN) of this observability configuration.

      • ObservabilityConfigurationName — (String)

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

      • ObservabilityConfigurationRevision — (Integer)

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

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

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"
        • "UPDATE_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.

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 Amazon Web Services 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. The failed service isn't usable, and still counts towards your service quota. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using UpdateService.

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

var params = {
  AutoScalingConfigurationArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
apprunner.listServicesForAutoScalingConfiguration(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 list the services for.

    The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either .../name or .../name/revision . If a revision isn't specified, the latest active revision is used.

  • 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 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:

    • ServiceArnList — (Array<String>)

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

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

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.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
apprunner.listVpcConnectors(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: {}) —
  • 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:

    • VpcConnectors — (Array<map>)

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

      • VpcConnectorName — (String)

        The customer-provided VPC connector name.

      • VpcConnectorArn — (String)

        The Amazon Resource Name (ARN) of this VPC connector.

      • VpcConnectorRevision — (Integer)

        The revision of this VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.

        Note: At this time, App Runner supports only one revision per name.
      • Subnets — (Array<String>)

        A list of IDs of subnets that App Runner uses for your service. All IDs are of subnets of a single Amazon VPC.

      • SecurityGroups — (Array<String>)

        A list of IDs of security groups that App Runner uses for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

      • Status — (String)

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

        Possible values include:
        • "ACTIVE"
        • "INACTIVE"
      • CreatedAt — (Date)

        The time when the VPC connector was created. It's in Unix time stamp format.

      • DeletedAt — (Date)

        The time when the VPC connector was deleted. It's in 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.

var params = {
  Filter: {
    ServiceArn: 'STRING_VALUE',
    VpcEndpointId: 'STRING_VALUE'
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
apprunner.listVpcIngressConnections(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: {}) —
  • Filter — (map)

    The VPC Ingress Connections to be listed based on either the Service Arn or Vpc Endpoint Id, or both.

    • ServiceArn — (String)

      The Amazon Resource Name (ARN) of a service to filter by.

    • VpcEndpointId — (String)

      The ID of a VPC Endpoint to filter by.

  • 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:

    • VpcIngressConnectionSummaryList — (Array<map>)

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

      • VpcIngressConnectionArn — (String)

        The Amazon Resource Name (ARN) of the VPC Ingress Connection.

      • ServiceArn — (String)

        The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection.

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

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.

      • ServiceName — required — (String)

        The customer-provided service name.

      • ServiceId — required — (String)

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

      • ServiceArn — required — (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 — required — (Date)

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

      • UpdatedAt — required — (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.

      • Status — required — (String)

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

        • CREATE_FAILED – The service failed to create. The failed service isn't usable, and still counts towards your service quota. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using UpdateService.

        • 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"
      • SourceConfiguration — required — (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).

          • RepositoryUrl — required — (String)

            The location of the repository that contains the source code.

          • SourceCodeVersion — required — (map)

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

            • Type — required — (String)

              The type of version identifier.

              For a git-based repository, branches represent versions.

              Possible values include:
              • "BRANCH"
            • Value — required — (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.

            Note: CodeConfiguration is required only for CreateService request.
            • ConfigurationSource — required — (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).

              • Runtime — required — (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"
                • "NODEJS_14"
                • "CORRETTO_8"
                • "CORRETTO_11"
                • "NODEJS_16"
                • "GO_1"
                • "DOTNET_6"
                • "PHP_81"
                • "RUBY_31"
                • "PYTHON_311"
                • "NODEJS_18"
              • 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.

              • RuntimeEnvironmentSecrets — (map<String>)

                An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

                Note:

                • If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services Region as the service that you're launching, you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.
                • Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported.
          • SourceDirectory — (String)

            The path of the directory that stores source code and configuration files. The build and start commands also execute from here. The path is absolute from root and, if not specified, defaults to the repository root.

        • ImageRepository — (map)

          The description of a source image repository.

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

          • ImageIdentifier — required — (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.

            • 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

            • RuntimeEnvironmentSecrets — (map<String>)

              An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

              Note:

              • If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services Region as the service that you're launching, you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.
              • Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported.
          • ImageRepositoryType — required — (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 (including any source code commit or new image version) starts a deployment.

          Default: App Runner sets to false for a source image that uses an ECR Public repository or an ECR repository that's in an Amazon Web Services account other than the one that the service is in. App Runner sets to true in all other cases (which currently include a source code repository or a source image using a same-account ECR repository).

        • 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 — required — (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 Amazon Web Services 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 Amazon Web Services managed key.

        • KmsKey — required — (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: 1

        • UnhealthyThreshold — (Integer)

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

          Default: 5

      • AutoScalingConfigurationSummary — required — (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.

        • 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"
        • CreatedAt — (Date)

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

        • HasAssociatedService — (Boolean)

          Indicates if this auto scaling configuration has an App Runner service associated with it. A value of true indicates one or more services are associated. A value of false indicates no services are associated.

        • IsDefault — (Boolean)

          Indicates if this auto scaling configuration should be used as the default for a new App Runner service that does not have an auto scaling configuration ARN specified during creation. Each account can have only one default AutoScalingConfiguration per region. The default AutoScalingConfiguration can be any revision under the same AutoScalingConfigurationName.

      • NetworkConfiguration — required — (map)

        Configuration settings related to network traffic of the web application that this service runs.

        • EgressConfiguration — (map)

          Network configuration settings for outbound message traffic.

          • EgressType — (String)

            The type of egress configuration.

            Set to DEFAULT for access to resources hosted on public networks.

            Set to VPC to associate your service to a custom VPC specified by VpcConnectorArn.

            Possible values include:
            • "DEFAULT"
            • "VPC"
          • VpcConnectorArn — (String)

            The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner service. Only valid when EgressType = VPC.

        • IngressConfiguration — (map)

          Network configuration settings for inbound message traffic.

          • IsPubliclyAccessible — (Boolean)

            Specifies whether your App Runner service is publicly accessible. To make the service publicly accessible set it to True. To make the service privately accessible, from only within an Amazon VPC set it to False.

        • IpAddressType — (String)

          App Runner provides you with the option to choose between Internet Protocol version 4 (IPv4) and dual stack (IPv4 and IPv6) for your incoming public network configuration. This is an optional parameter. If you do not specify an IpAddressType, it defaults to select IPv4.

          Note: Currently, App Runner supports dual stack for only Public endpoint. Only IPv4 is supported for Private endpoint. If you update a service that's using dual-stack Public endpoint to a Private endpoint, your App Runner service will default to support only IPv4 for Private endpoint and fail to receive traffic originating from IPv6 endpoint.
          Possible values include:
          • "IPV4"
          • "DUAL_STACK"
      • ObservabilityConfiguration — (map)

        The observability configuration of this service.

        • ObservabilityEnabled — required — (Boolean)

          When true, an observability configuration resource is associated with the service, and an ObservabilityConfigurationArn is specified.

        • ObservabilityConfigurationArn — (String)

          The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when ObservabilityEnabled is true.

          Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3

          Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing

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