Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

UpdateServiceCommand

Update an App Runner service. You can update the source configuration and instance configuration of the service. You can also update the ARN of the auto scaling configuration resource that's associated with the service. However, you can't change the name or the encryption configuration of the service. These can be set only when you create the service.

To update the tags applied to your service, use the separate actions TagResource and UntagResource.

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AppRunnerClient, UpdateServiceCommand } from "@aws-sdk/client-apprunner"; // ES Modules import
// const { AppRunnerClient, UpdateServiceCommand } = require("@aws-sdk/client-apprunner"); // CommonJS import
const client = new AppRunnerClient(config);
const input = { // UpdateServiceRequest
  ServiceArn: "STRING_VALUE", // required
  SourceConfiguration: { // SourceConfiguration
    CodeRepository: { // CodeRepository
      RepositoryUrl: "STRING_VALUE", // required
      SourceCodeVersion: { // SourceCodeVersion
        Type: "BRANCH", // required
        Value: "STRING_VALUE", // required
      },
      CodeConfiguration: { // CodeConfiguration
        ConfigurationSource: "REPOSITORY" || "API", // required
        CodeConfigurationValues: { // 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" || "NODEJS_22", // required
          BuildCommand: "STRING_VALUE",
          StartCommand: "STRING_VALUE",
          Port: "STRING_VALUE",
          RuntimeEnvironmentVariables: { // RuntimeEnvironmentVariables
            "<keys>": "STRING_VALUE",
          },
          RuntimeEnvironmentSecrets: { // RuntimeEnvironmentSecrets
            "<keys>": "STRING_VALUE",
          },
        },
      },
      SourceDirectory: "STRING_VALUE",
    },
    ImageRepository: { // ImageRepository
      ImageIdentifier: "STRING_VALUE", // required
      ImageConfiguration: { // ImageConfiguration
        RuntimeEnvironmentVariables: {
          "<keys>": "STRING_VALUE",
        },
        StartCommand: "STRING_VALUE",
        Port: "STRING_VALUE",
        RuntimeEnvironmentSecrets: {
          "<keys>": "STRING_VALUE",
        },
      },
      ImageRepositoryType: "ECR" || "ECR_PUBLIC", // required
    },
    AutoDeploymentsEnabled: true || false,
    AuthenticationConfiguration: { // AuthenticationConfiguration
      ConnectionArn: "STRING_VALUE",
      AccessRoleArn: "STRING_VALUE",
    },
  },
  InstanceConfiguration: { // InstanceConfiguration
    Cpu: "STRING_VALUE",
    Memory: "STRING_VALUE",
    InstanceRoleArn: "STRING_VALUE",
  },
  AutoScalingConfigurationArn: "STRING_VALUE",
  HealthCheckConfiguration: { // HealthCheckConfiguration
    Protocol: "TCP" || "HTTP",
    Path: "STRING_VALUE",
    Interval: Number("int"),
    Timeout: Number("int"),
    HealthyThreshold: Number("int"),
    UnhealthyThreshold: Number("int"),
  },
  NetworkConfiguration: { // NetworkConfiguration
    EgressConfiguration: { // EgressConfiguration
      EgressType: "DEFAULT" || "VPC",
      VpcConnectorArn: "STRING_VALUE",
    },
    IngressConfiguration: { // IngressConfiguration
      IsPubliclyAccessible: true || false,
    },
    IpAddressType: "IPV4" || "DUAL_STACK",
  },
  ObservabilityConfiguration: { // ServiceObservabilityConfiguration
    ObservabilityEnabled: true || false, // required
    ObservabilityConfigurationArn: "STRING_VALUE",
  },
};
const command = new UpdateServiceCommand(input);
const response = await client.send(command);
// { // UpdateServiceResponse
//   Service: { // Service
//     ServiceName: "STRING_VALUE", // required
//     ServiceId: "STRING_VALUE", // required
//     ServiceArn: "STRING_VALUE", // required
//     ServiceUrl: "STRING_VALUE",
//     CreatedAt: new Date("TIMESTAMP"), // required
//     UpdatedAt: new Date("TIMESTAMP"), // required
//     DeletedAt: new Date("TIMESTAMP"),
//     Status: "CREATE_FAILED" || "RUNNING" || "DELETED" || "DELETE_FAILED" || "PAUSED" || "OPERATION_IN_PROGRESS", // required
//     SourceConfiguration: { // SourceConfiguration
//       CodeRepository: { // CodeRepository
//         RepositoryUrl: "STRING_VALUE", // required
//         SourceCodeVersion: { // SourceCodeVersion
//           Type: "BRANCH", // required
//           Value: "STRING_VALUE", // required
//         },
//         CodeConfiguration: { // CodeConfiguration
//           ConfigurationSource: "REPOSITORY" || "API", // required
//           CodeConfigurationValues: { // 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" || "NODEJS_22", // required
//             BuildCommand: "STRING_VALUE",
//             StartCommand: "STRING_VALUE",
//             Port: "STRING_VALUE",
//             RuntimeEnvironmentVariables: { // RuntimeEnvironmentVariables
//               "<keys>": "STRING_VALUE",
//             },
//             RuntimeEnvironmentSecrets: { // RuntimeEnvironmentSecrets
//               "<keys>": "STRING_VALUE",
//             },
//           },
//         },
//         SourceDirectory: "STRING_VALUE",
//       },
//       ImageRepository: { // ImageRepository
//         ImageIdentifier: "STRING_VALUE", // required
//         ImageConfiguration: { // ImageConfiguration
//           RuntimeEnvironmentVariables: {
//             "<keys>": "STRING_VALUE",
//           },
//           StartCommand: "STRING_VALUE",
//           Port: "STRING_VALUE",
//           RuntimeEnvironmentSecrets: {
//             "<keys>": "STRING_VALUE",
//           },
//         },
//         ImageRepositoryType: "ECR" || "ECR_PUBLIC", // required
//       },
//       AutoDeploymentsEnabled: true || false,
//       AuthenticationConfiguration: { // AuthenticationConfiguration
//         ConnectionArn: "STRING_VALUE",
//         AccessRoleArn: "STRING_VALUE",
//       },
//     },
//     InstanceConfiguration: { // InstanceConfiguration
//       Cpu: "STRING_VALUE",
//       Memory: "STRING_VALUE",
//       InstanceRoleArn: "STRING_VALUE",
//     },
//     EncryptionConfiguration: { // EncryptionConfiguration
//       KmsKey: "STRING_VALUE", // required
//     },
//     HealthCheckConfiguration: { // HealthCheckConfiguration
//       Protocol: "TCP" || "HTTP",
//       Path: "STRING_VALUE",
//       Interval: Number("int"),
//       Timeout: Number("int"),
//       HealthyThreshold: Number("int"),
//       UnhealthyThreshold: Number("int"),
//     },
//     AutoScalingConfigurationSummary: { // AutoScalingConfigurationSummary
//       AutoScalingConfigurationArn: "STRING_VALUE",
//       AutoScalingConfigurationName: "STRING_VALUE",
//       AutoScalingConfigurationRevision: Number("int"),
//       Status: "ACTIVE" || "INACTIVE",
//       CreatedAt: new Date("TIMESTAMP"),
//       HasAssociatedService: true || false,
//       IsDefault: true || false,
//     },
//     NetworkConfiguration: { // NetworkConfiguration
//       EgressConfiguration: { // EgressConfiguration
//         EgressType: "DEFAULT" || "VPC",
//         VpcConnectorArn: "STRING_VALUE",
//       },
//       IngressConfiguration: { // IngressConfiguration
//         IsPubliclyAccessible: true || false,
//       },
//       IpAddressType: "IPV4" || "DUAL_STACK",
//     },
//     ObservabilityConfiguration: { // ServiceObservabilityConfiguration
//       ObservabilityEnabled: true || false, // required
//       ObservabilityConfigurationArn: "STRING_VALUE",
//     },
//   },
//   OperationId: "STRING_VALUE", // required
// };

UpdateServiceCommand Input

See UpdateServiceCommandInput for more details

Parameter	Type	Description
`ServiceArn` Required	`string \| undefined`	The Amazon Resource Name (ARN) of the App Runner service that you want to update.
`AutoScalingConfigurationArn`	`string \| undefined`	The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with the App Runner service.
`HealthCheckConfiguration`	`HealthCheckConfiguration \| undefined`	The settings for the health check that App Runner performs to monitor the health of the App Runner service.
`InstanceConfiguration`	`InstanceConfiguration \| undefined`	The runtime configuration to apply to instances (scaling units) of your service.
`NetworkConfiguration`	`NetworkConfiguration \| undefined`	Configuration settings related to network traffic of the web application that the App Runner service runs.
`ObservabilityConfiguration`	`ServiceObservabilityConfiguration \| undefined`	The observability configuration of your service.
`SourceConfiguration`	`SourceConfiguration \| undefined`	The source configuration to apply to the App Runner service. You can change the configuration of the code or image repository that the service uses. However, you can't switch from code to image or the other way around. This means that you must provide the same structure member of `SourceConfiguration` that you originally included when you created the service. Specifically, you can include either `CodeRepository` or `ImageRepository`. To update the source configuration, set the values to members of the structure that you include.

UpdateServiceCommand Output

See UpdateServiceCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`OperationId` Required	`string \| undefined`	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.
`Service` Required	`Service \| undefined`	A description of the App Runner service updated by this request. All configuration values in the returned `Service` structure reflect configuration changes that are being applied by this request.

Throws

Name	Fault	Details
InternalServiceErrorException	server	An unexpected service exception occurred.
InvalidRequestException	client	One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.
InvalidStateException	client	You can't perform this action when the resource is in its current state.
ResourceNotFoundException	client	A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.
AppRunnerServiceException		Base exception class for all service exceptions from AppRunner service.

Getting Started

References

UpdateServiceCommand

Example Syntax

UpdateServiceCommand Input

UpdateServiceCommand Output

Throws

Table of Contents

Search