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

Inherits:

Struct

Object
Struct
Aws::AppRunner::Types::Service

show all

Includes:: Structure

Defined in:: lib/aws-sdk-apprunner/types.rb

Overview

Describes an 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][3: actions. A subset of this

information is returned by the [ListServices] action using the

ServiceSummary][5: type.

[1]: docs.aws.amazon.com/apprunner/latest/api/API_CreateService.html [2]: docs.aws.amazon.com/apprunner/latest/api/API_DescribeService.html [3]: docs.aws.amazon.com/apprunner/latest/api/API_DeleteService.html [4]: docs.aws.amazon.com/apprunner/latest/api/API_ListServices.html [5]: docs.aws.amazon.com/apprunner/latest/api/API_ServiceSummary.html

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#auto_scaling_configuration_summary ⇒ Types::AutoScalingConfigurationSummary

Summary information for the App Runner automatic scaling configuration resource that’s associated with this service.
#created_at ⇒ Time

The time when the App Runner service was created.
#deleted_at ⇒ Time

The time when the App Runner service was deleted.
#encryption_configuration ⇒ Types::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.
#health_check_configuration ⇒ Types::HealthCheckConfiguration

The settings for the health check that App Runner performs to monitor the health of this service.
#instance_configuration ⇒ Types::InstanceConfiguration

The runtime configuration of instances (scaling units) of this service.
#network_configuration ⇒ Types::NetworkConfiguration

Configuration settings related to network traffic of the web application that this service runs.
#observability_configuration ⇒ Types::ServiceObservabilityConfiguration

The observability configuration of this service.
#service_arn ⇒ String

The Amazon Resource Name (ARN) of this service.
#service_id ⇒ String

An ID that App Runner generated for this service.
#service_name ⇒ String

The customer-provided service name.
#service_url ⇒ String

A subdomain URL that App Runner generated for this service.
#source_configuration ⇒ Types::SourceConfiguration

The source deployed to the App Runner service.
#status ⇒ String

The current state of the App Runner service.
#updated_at ⇒ Time

The time when the App Runner service was last updated at.

Instance Attribute Details

#auto_scaling_configuration_summary ⇒ `Types::AutoScalingConfigurationSummary`

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

Returns:

(Types::AutoScalingConfigurationSummary)

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

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,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ `Time`

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

Returns:

(Time)

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

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,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#deleted_at ⇒ `Time`

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

Returns:

(Time)

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

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,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configuration ⇒ `Types::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 Amazon Web Services managed key.

Returns:

(Types::EncryptionConfiguration)

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

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,
  :network_configuration,
  :observability_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 this service.

Returns:

(Types::HealthCheckConfiguration)

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

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,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#instance_configuration ⇒ `Types::InstanceConfiguration`

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

Returns:

(Types::InstanceConfiguration)

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

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,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#network_configuration ⇒ `Types::NetworkConfiguration`

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

Returns:

(Types::NetworkConfiguration)

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

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,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#observability_configuration ⇒ `Types::ServiceObservabilityConfiguration`

The observability configuration of this service.

Returns:

(Types::ServiceObservabilityConfiguration)

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

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,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#service_arn ⇒ `String`

The Amazon Resource Name (ARN) of this service.

Returns:

(String)

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

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,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#service_id ⇒ `String`

An ID that App Runner generated for this service. It’s unique within the Amazon Web Services Region.

Returns:

(String)

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

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,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#service_name ⇒ `String`

The customer-provided service name.

Returns:

(String)

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

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,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#service_url ⇒ `String`

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

Returns:

(String)

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

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,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#source_configuration ⇒ `Types::SourceConfiguration`

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

Returns:

(Types::SourceConfiguration)

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

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,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

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

‘CREATE_FAILED` – The service failed to create. The failed service isn’t usable, and still counts towards your service quota. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using ‘UpdateService`.
‘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)

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

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,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ `Time`

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

Returns:

(Time)

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

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,
  :network_configuration,
  :observability_configuration)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_configuration_summary ⇒ Types::AutoScalingConfigurationSummary

#created_at ⇒ Time

#deleted_at ⇒ Time

#encryption_configuration ⇒ Types::EncryptionConfiguration

#health_check_configuration ⇒ Types::HealthCheckConfiguration

#instance_configuration ⇒ Types::InstanceConfiguration

#network_configuration ⇒ Types::NetworkConfiguration

#observability_configuration ⇒ Types::ServiceObservabilityConfiguration

#service_arn ⇒ String

#service_id ⇒ String

#service_name ⇒ String

#service_url ⇒ String

#source_configuration ⇒ Types::SourceConfiguration

#status ⇒ String

#updated_at ⇒ Time

#auto_scaling_configuration_summary ⇒ `Types::AutoScalingConfigurationSummary`

#created_at ⇒ `Time`

#deleted_at ⇒ `Time`

#encryption_configuration ⇒ `Types::EncryptionConfiguration`

#health_check_configuration ⇒ `Types::HealthCheckConfiguration`

#instance_configuration ⇒ `Types::InstanceConfiguration`

#network_configuration ⇒ `Types::NetworkConfiguration`

#observability_configuration ⇒ `Types::ServiceObservabilityConfiguration`

#service_arn ⇒ `String`

#service_id ⇒ `String`

#service_name ⇒ `String`

#service_url ⇒ `String`

#source_configuration ⇒ `Types::SourceConfiguration`

#status ⇒ `String`

#updated_at ⇒ `Time`