Pause Service

apprunner_pause_service

R Documentation

Pause an active App Runner service

Description

Pause an active App Runner service. App Runner reduces compute capacity for the service to zero and loses state (for example, ephemeral storage is removed).

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

Usage

apprunner_pause_service(ServiceArn)

Arguments

ServiceArn

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

Value

A list with the following syntax:

list(
  Service = list(
    ServiceName = "string",
    ServiceId = "string",
    ServiceArn = "string",
    ServiceUrl = "string",
    CreatedAt = as.POSIXct(
      "2015-01-01"
    ),
    UpdatedAt = as.POSIXct(
      "2015-01-01"
    ),
    DeletedAt = as.POSIXct(
      "2015-01-01"
    ),
    Status = "CREATE_FAILED"|"RUNNING"|"DELETED"|"DELETE_FAILED"|"PAUSED"|"OPERATION_IN_PROGRESS",
    SourceConfiguration = list(
      CodeRepository = list(
        RepositoryUrl = "string",
        SourceCodeVersion = list(
          Type = "BRANCH",
          Value = "string"
        ),
        CodeConfiguration = list(
          ConfigurationSource = "REPOSITORY"|"API",
          CodeConfigurationValues = list(
            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",
            BuildCommand = "string",
            StartCommand = "string",
            Port = "string",
            RuntimeEnvironmentVariables = list(
              "string"
            ),
            RuntimeEnvironmentSecrets = list(
              "string"
            )
          )
        ),
        SourceDirectory = "string"
      ),
      ImageRepository = list(
        ImageIdentifier = "string",
        ImageConfiguration = list(
          RuntimeEnvironmentVariables = list(
            "string"
          ),
          StartCommand = "string",
          Port = "string",
          RuntimeEnvironmentSecrets = list(
            "string"
          )
        ),
        ImageRepositoryType = "ECR"|"ECR_PUBLIC"
      ),
      AutoDeploymentsEnabled = TRUE|FALSE,
      AuthenticationConfiguration = list(
        ConnectionArn = "string",
        AccessRoleArn = "string"
      )
    ),
    InstanceConfiguration = list(
      Cpu = "string",
      Memory = "string",
      InstanceRoleArn = "string"
    ),
    EncryptionConfiguration = list(
      KmsKey = "string"
    ),
    HealthCheckConfiguration = list(
      Protocol = "TCP"|"HTTP",
      Path = "string",
      Interval = 123,
      Timeout = 123,
      HealthyThreshold = 123,
      UnhealthyThreshold = 123
    ),
    AutoScalingConfigurationSummary = list(
      AutoScalingConfigurationArn = "string",
      AutoScalingConfigurationName = "string",
      AutoScalingConfigurationRevision = 123,
      Status = "ACTIVE"|"INACTIVE",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      HasAssociatedService = TRUE|FALSE,
      IsDefault = TRUE|FALSE
    ),
    NetworkConfiguration = list(
      EgressConfiguration = list(
        EgressType = "DEFAULT"|"VPC",
        VpcConnectorArn = "string"
      ),
      IngressConfiguration = list(
        IsPubliclyAccessible = TRUE|FALSE
      ),
      IpAddressType = "IPV4"|"DUAL_STACK"
    ),
    ObservabilityConfiguration = list(
      ObservabilityEnabled = TRUE|FALSE,
      ObservabilityConfigurationArn = "string"
    )
  ),
  OperationId = "string"
)

Request syntax

svc$pause_service(
  ServiceArn = "string"
)