Class: Aws::AppRunner::Types::UpdateServiceRequest

Inherits:

Struct

• Object
• Struct
• Aws::AppRunner::Types::UpdateServiceRequest

Defined in:

gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb

Overview

Note:

When making an API call, you may pass UpdateServiceRequest data as a hash:

{
  service_arn: "AppRunnerResourceArn", # required
  source_configuration: {
    code_repository: {
      repository_url: "String", # required
      source_code_version: { # required
        type: "BRANCH", # required, accepts BRANCH
        value: "String", # required
      },
      code_configuration: {
        configuration_source: "REPOSITORY", # required, accepts REPOSITORY, API
        code_configuration_values: {
          runtime: "PYTHON_3", # required, accepts PYTHON_3, NODEJS_12
          build_command: "BuildCommand",
          start_command: "StartCommand",
          port: "String",
          runtime_environment_variables: {
            "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue",
          },
        },
      },
    },
    image_repository: {
      image_identifier: "ImageIdentifier", # required
      image_configuration: {
        runtime_environment_variables: {
          "RuntimeEnvironmentVariablesKey" => "RuntimeEnvironmentVariablesValue",
        },
        start_command: "String",
        port: "String",
      },
      image_repository_type: "ECR", # required, accepts ECR, ECR_PUBLIC
    },
    auto_deployments_enabled: false,
    authentication_configuration: {
      connection_arn: "AppRunnerResourceArn",
      access_role_arn: "RoleArn",
    },
  },
  instance_configuration: {
    cpu: "Cpu",
    memory: "Memory",
    instance_role_arn: "RoleArn",
  },
  auto_scaling_configuration_arn: "AppRunnerResourceArn",
  health_check_configuration: {
    protocol: "TCP", # accepts TCP, HTTP
    path: "HealthCheckPath",
    interval: 1,
    timeout: 1,
    healthy_threshold: 1,
    unhealthy_threshold: 1,
  },
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #auto_scaling_configuration_arn ⇒ String

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

• #health_check_configuration ⇒ Types::HealthCheckConfiguration

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

• #instance_configuration ⇒ Types::InstanceConfiguration

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

• #service_arn ⇒ String

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

• #source_configuration ⇒ Types::SourceConfiguration

  The source configuration to apply to the App Runner service.

Instance Attribute Details

#auto_scaling_configuration_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 2380

class UpdateServiceRequest < Struct.new(
  :service_arn,
  :source_configuration,
  :instance_configuration,
  :auto_scaling_configuration_arn,
  :health_check_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_configuration ⇒ Types::HealthCheckConfiguration

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

Returns:

• (Types::HealthCheckConfiguration)

# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 2380

class UpdateServiceRequest < Struct.new(
  :service_arn,
  :source_configuration,
  :instance_configuration,
  :auto_scaling_configuration_arn,
  :health_check_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#instance_configuration ⇒ Types::InstanceConfiguration

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

Returns:

• (Types::InstanceConfiguration)

# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 2380

class UpdateServiceRequest < Struct.new(
  :service_arn,
  :source_configuration,
  :instance_configuration,
  :auto_scaling_configuration_arn,
  :health_check_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#service_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 2380

class UpdateServiceRequest < Struct.new(
  :service_arn,
  :source_configuration,
  :instance_configuration,
  :auto_scaling_configuration_arn,
  :health_check_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#source_configuration ⇒ Types::SourceConfiguration

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.

Returns:

• (Types::SourceConfiguration)

# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 2380

class UpdateServiceRequest < Struct.new(
  :service_arn,
  :source_configuration,
  :instance_configuration,
  :auto_scaling_configuration_arn,
  :health_check_configuration)
  SENSITIVE = []
  include Aws::Structure
end