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 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.



2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 2547

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_atTime

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

Returns:

  • (Time)


2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 2547

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_atTime

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

Returns:

  • (Time)


2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 2547

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_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 Amazon Web Services managed key.



2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 2547

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_configurationTypes::HealthCheckConfiguration

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



2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 2547

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_configurationTypes::InstanceConfiguration

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



2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 2547

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_configurationTypes::NetworkConfiguration

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



2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 2547

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_configurationTypes::ServiceObservabilityConfiguration

The observability configuration of this service.



2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 2547

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_arnString

The Amazon Resource Name (ARN) of this service.

Returns:

  • (String)


2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 2547

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_idString

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

Returns:

  • (String)


2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 2547

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_nameString

The customer-provided service name.

Returns:

  • (String)


2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 2547

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_urlString

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

Returns:

  • (String)


2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 2547

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_configurationTypes::SourceConfiguration

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



2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 2547

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

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


2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 2547

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_atTime

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

Returns:

  • (Time)


2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
# File 'gems/aws-sdk-apprunner/lib/aws-sdk-apprunner/types.rb', line 2547

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