Describe Service

apprunner_describe_service

R Documentation

Return a full description of an App Runner service

Description

Return a full description of an App Runner service.

Usage

apprunner_describe_service(ServiceArn)

Arguments

ServiceArn

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

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

Request syntax

svc$describe_service(
  ServiceArn = "string"
)