Documentation

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.

See: newService smart constructor.

Create a value of Service with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:encryptionConfiguration:Service', service_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 CMK.

$sel:healthCheckConfiguration:Service', service_healthCheckConfiguration - The settings for the health check that App Runner performs to monitor the health of this service.

$sel:deletedAt:Service', service_deletedAt - The time when the App Runner service was deleted. It's in the Unix time stamp format.

$sel:serviceName:Service', service_serviceName - The customer-provided service name.

$sel:serviceId:Service', service_serviceId - An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.

$sel:serviceArn:Service', service_serviceArn - The Amazon Resource Name (ARN) of this service.

$sel:serviceUrl:Service', service_serviceUrl - A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.

$sel:createdAt:Service', service_createdAt - The time when the App Runner service was created. It's in the Unix time stamp format.

$sel:updatedAt:Service', service_updatedAt - The time when the App Runner service was last updated at. It's in the Unix time stamp format.

$sel:status:Service', service_status - 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.

$sel:sourceConfiguration:Service', service_sourceConfiguration - The source deployed to the App Runner service. It can be a code or an image repository.

$sel:instanceConfiguration:Service', service_instanceConfiguration - The runtime configuration of instances (scaling units) of this service.

$sel:autoScalingConfigurationSummary:Service', service_autoScalingConfigurationSummary - Summary information for the App Runner automatic scaling configuration resource that's associated with this service.

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

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

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

The customer-provided service name.

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

The Amazon Resource Name (ARN) of this service.

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

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

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

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.

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

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

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