Class: Aws::AppRunner::Types::Service

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb

Overview

Describes an AWS App Runner service. It can describe a service in any state, including deleted services.

This type contains the full information about a service, including configuration details. It's returned by the CreateService, DescribeService, and DeleteService actions. A subset of this information is returned by the ListServices action using the ServiceSummary type.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_configuration_summaryTypes::AutoScalingConfigurationSummary

Summary information for the App Runner automatic scaling configuration resource that's associated with this service.



1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 1915

class Service < Struct.new(
  :service_name,
  :service_id,
  :service_arn,
  :service_url,
  :created_at,
  :updated_at,
  :deleted_at,
  :status,
  :source_configuration,
  :instance_configuration,
  :encryption_configuration,
  :health_check_configuration,
  :auto_scaling_configuration_summary)
  SENSITIVE = []
  include Aws::Structure
end

#created_atTime

The time when the App Runner service was created. It's in the Unix time stamp format.

Returns:

  • (Time)


1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 1915

class Service < Struct.new(
  :service_name,
  :service_id,
  :service_arn,
  :service_url,
  :created_at,
  :updated_at,
  :deleted_at,
  :status,
  :source_configuration,
  :instance_configuration,
  :encryption_configuration,
  :health_check_configuration,
  :auto_scaling_configuration_summary)
  SENSITIVE = []
  include Aws::Structure
end

#deleted_atTime

The time when the App Runner service was deleted. It's in the Unix time stamp format.

Returns:

  • (Time)


1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 1915

class Service < Struct.new(
  :service_name,
  :service_id,
  :service_arn,
  :service_url,
  :created_at,
  :updated_at,
  :deleted_at,
  :status,
  :source_configuration,
  :instance_configuration,
  :encryption_configuration,
  :health_check_configuration,
  :auto_scaling_configuration_summary)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configurationTypes::EncryptionConfiguration

The encryption key that App Runner uses to encrypt the service logs and the copy of the source repository that App Runner maintains for the service. It can be either a customer-provided encryption key or an AWS managed CMK.



1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 1915

class Service < Struct.new(
  :service_name,
  :service_id,
  :service_arn,
  :service_url,
  :created_at,
  :updated_at,
  :deleted_at,
  :status,
  :source_configuration,
  :instance_configuration,
  :encryption_configuration,
  :health_check_configuration,
  :auto_scaling_configuration_summary)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_configurationTypes::HealthCheckConfiguration

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



1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 1915

class Service < Struct.new(
  :service_name,
  :service_id,
  :service_arn,
  :service_url,
  :created_at,
  :updated_at,
  :deleted_at,
  :status,
  :source_configuration,
  :instance_configuration,
  :encryption_configuration,
  :health_check_configuration,
  :auto_scaling_configuration_summary)
  SENSITIVE = []
  include Aws::Structure
end

#instance_configurationTypes::InstanceConfiguration

The runtime configuration of instances (scaling units) of this service.



1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 1915

class Service < Struct.new(
  :service_name,
  :service_id,
  :service_arn,
  :service_url,
  :created_at,
  :updated_at,
  :deleted_at,
  :status,
  :source_configuration,
  :instance_configuration,
  :encryption_configuration,
  :health_check_configuration,
  :auto_scaling_configuration_summary)
  SENSITIVE = []
  include Aws::Structure
end

#service_arnString

The Amazon Resource Name (ARN) of this service.

Returns:

  • (String)


1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 1915

class Service < Struct.new(
  :service_name,
  :service_id,
  :service_arn,
  :service_url,
  :created_at,
  :updated_at,
  :deleted_at,
  :status,
  :source_configuration,
  :instance_configuration,
  :encryption_configuration,
  :health_check_configuration,
  :auto_scaling_configuration_summary)
  SENSITIVE = []
  include Aws::Structure
end

#service_idString

An ID that App Runner generated for this service. It's unique within the AWS Region.

Returns:

  • (String)


1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 1915

class Service < Struct.new(
  :service_name,
  :service_id,
  :service_arn,
  :service_url,
  :created_at,
  :updated_at,
  :deleted_at,
  :status,
  :source_configuration,
  :instance_configuration,
  :encryption_configuration,
  :health_check_configuration,
  :auto_scaling_configuration_summary)
  SENSITIVE = []
  include Aws::Structure
end

#service_nameString

The customer-provided service name.

Returns:

  • (String)


1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 1915

class Service < Struct.new(
  :service_name,
  :service_id,
  :service_arn,
  :service_url,
  :created_at,
  :updated_at,
  :deleted_at,
  :status,
  :source_configuration,
  :instance_configuration,
  :encryption_configuration,
  :health_check_configuration,
  :auto_scaling_configuration_summary)
  SENSITIVE = []
  include Aws::Structure
end

#service_urlString

A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.

Returns:

  • (String)


1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 1915

class Service < Struct.new(
  :service_name,
  :service_id,
  :service_arn,
  :service_url,
  :created_at,
  :updated_at,
  :deleted_at,
  :status,
  :source_configuration,
  :instance_configuration,
  :encryption_configuration,
  :health_check_configuration,
  :auto_scaling_configuration_summary)
  SENSITIVE = []
  include Aws::Structure
end

#source_configurationTypes::SourceConfiguration

The source deployed to the App Runner service. It can be a code or an image repository.



1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 1915

class Service < Struct.new(
  :service_name,
  :service_id,
  :service_arn,
  :service_url,
  :created_at,
  :updated_at,
  :deleted_at,
  :status,
  :source_configuration,
  :instance_configuration,
  :encryption_configuration,
  :health_check_configuration,
  :auto_scaling_configuration_summary)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The current state of the App Runner service. These particular values mean the following.

  • CREATE_FAILED – The service failed to create. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and retry the call to create the service.

    The failed service isn't usable, and still counts towards your service quota. When you're done analyzing the failure, delete the service.

  • DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.

Returns:

  • (String)


1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 1915

class Service < Struct.new(
  :service_name,
  :service_id,
  :service_arn,
  :service_url,
  :created_at,
  :updated_at,
  :deleted_at,
  :status,
  :source_configuration,
  :instance_configuration,
  :encryption_configuration,
  :health_check_configuration,
  :auto_scaling_configuration_summary)
  SENSITIVE = []
  include Aws::Structure
end

#updated_atTime

The time when the App Runner service was last updated at. It's in the Unix time stamp format.

Returns:

  • (Time)


1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 1915

class Service < Struct.new(
  :service_name,
  :service_id,
  :service_arn,
  :service_url,
  :created_at,
  :updated_at,
  :deleted_at,
  :status,
  :source_configuration,
  :instance_configuration,
  :encryption_configuration,
  :health_check_configuration,
  :auto_scaling_configuration_summary)
  SENSITIVE = []
  include Aws::Structure
end