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

Inherits:
Struct
  • Object
show all
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, NODEJS_14, CORRETTO_8, CORRETTO_11
          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: "StartCommand",
        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,
  },
  network_configuration: {
    egress_configuration: {
      egress_type: "DEFAULT", # accepts DEFAULT, VPC
      vpc_connector_arn: "AppRunnerResourceArn",
    },
  },
  observability_configuration: {
    observability_enabled: false, # required
    observability_configuration_arn: "AppRunnerResourceArn",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_configuration_arnString

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

Returns:

  • (String)


3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 3086

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

#health_check_configurationTypes::HealthCheckConfiguration

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



3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 3086

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

#instance_configurationTypes::InstanceConfiguration

The runtime configuration to apply to instances (scaling units) of your service.



3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 3086

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

#network_configurationTypes::NetworkConfiguration

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



3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 3086

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

#observability_configurationTypes::ServiceObservabilityConfiguration

The observability configuration of your service.



3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 3086

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

#service_arnString

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

Returns:

  • (String)


3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 3086

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

#source_configurationTypes::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.



3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 3086

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