/AWS1/CL_APRSERVICE¶
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.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
IV_SERVICENAME TYPE /AWS1/APRSERVICENAME /AWS1/APRSERVICENAME¶
The customer-provided service name.
IV_SERVICEID TYPE /AWS1/APRSERVICEID /AWS1/APRSERVICEID¶
An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.
IV_SERVICEARN TYPE /AWS1/APRAPPRUNNERRESOURCEARN /AWS1/APRAPPRUNNERRESOURCEARN¶
The Amazon Resource Name (ARN) of this service.
IV_CREATEDAT TYPE /AWS1/APRTIMESTAMP /AWS1/APRTIMESTAMP¶
The time when the App Runner service was created. It's in the Unix time stamp format.
IV_UPDATEDAT TYPE /AWS1/APRTIMESTAMP /AWS1/APRTIMESTAMP¶
The time when the App Runner service was last updated at. It's in the Unix time stamp format.
IV_STATUS TYPE /AWS1/APRSERVICESTATUS /AWS1/APRSERVICESTATUS¶
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 usingUpdateService.
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.
IO_SOURCECONFIGURATION TYPE REF TO /AWS1/CL_APRSOURCECONF /AWS1/CL_APRSOURCECONF¶
The source deployed to the App Runner service. It can be a code or an image repository.
IO_INSTANCECONFIGURATION TYPE REF TO /AWS1/CL_APRINSTANCECONF /AWS1/CL_APRINSTANCECONF¶
The runtime configuration of instances (scaling units) of this service.
IO_AUTOSCALINGCONFSUMMARY TYPE REF TO /AWS1/CL_APRAUTOSCCONFSUMMARY /AWS1/CL_APRAUTOSCCONFSUMMARY¶
Summary information for the App Runner automatic scaling configuration resource that's associated with this service.
IO_NETWORKCONFIGURATION TYPE REF TO /AWS1/CL_APRNETWORKCONF /AWS1/CL_APRNETWORKCONF¶
Configuration settings related to network traffic of the web application that this service runs.
Optional arguments:¶
IV_SERVICEURL TYPE /AWS1/APRSTRING /AWS1/APRSTRING¶
A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.
IV_DELETEDAT TYPE /AWS1/APRTIMESTAMP /AWS1/APRTIMESTAMP¶
The time when the App Runner service was deleted. It's in the Unix time stamp format.
IO_ENCRYPTIONCONFIGURATION TYPE REF TO /AWS1/CL_APRENCRYPTIONCONF /AWS1/CL_APRENCRYPTIONCONF¶
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.
IO_HEALTHCHECKCONFIGURATION TYPE REF TO /AWS1/CL_APRHEALTHCHECKCONF /AWS1/CL_APRHEALTHCHECKCONF¶
The settings for the health check that App Runner performs to monitor the health of this service.
IO_OBSERVABILITYCONF TYPE REF TO /AWS1/CL_APRSVCOBSERVABILITY00 /AWS1/CL_APRSVCOBSERVABILITY00¶
The observability configuration of this service.
Queryable Attributes¶
ServiceName¶
The customer-provided service name.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERVICENAME() |
Getter for SERVICENAME, with configurable default |
ASK_SERVICENAME() |
Getter for SERVICENAME w/ exceptions if field has no value |
HAS_SERVICENAME() |
Determine if SERVICENAME has a value |
ServiceId¶
An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERVICEID() |
Getter for SERVICEID, with configurable default |
ASK_SERVICEID() |
Getter for SERVICEID w/ exceptions if field has no value |
HAS_SERVICEID() |
Determine if SERVICEID has a value |
ServiceArn¶
The Amazon Resource Name (ARN) of this service.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERVICEARN() |
Getter for SERVICEARN, with configurable default |
ASK_SERVICEARN() |
Getter for SERVICEARN w/ exceptions if field has no value |
HAS_SERVICEARN() |
Determine if SERVICEARN has a value |
ServiceUrl¶
A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERVICEURL() |
Getter for SERVICEURL, with configurable default |
ASK_SERVICEURL() |
Getter for SERVICEURL w/ exceptions if field has no value |
HAS_SERVICEURL() |
Determine if SERVICEURL has a value |
CreatedAt¶
The time when the App Runner service was created. It's in the Unix time stamp format.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
UpdatedAt¶
The time when the App Runner service was last updated at. It's in the Unix time stamp format.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UPDATEDAT() |
Getter for UPDATEDAT, with configurable default |
ASK_UPDATEDAT() |
Getter for UPDATEDAT w/ exceptions if field has no value |
HAS_UPDATEDAT() |
Determine if UPDATEDAT has a value |
DeletedAt¶
The time when the App Runner service was deleted. It's in the Unix time stamp format.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DELETEDAT() |
Getter for DELETEDAT, with configurable default |
ASK_DELETEDAT() |
Getter for DELETEDAT w/ exceptions if field has no value |
HAS_DELETEDAT() |
Determine if DELETEDAT has a value |
Status¶
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 usingUpdateService.
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
SourceConfiguration¶
The source deployed to the App Runner service. It can be a code or an image repository.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SOURCECONFIGURATION() |
Getter for SOURCECONFIGURATION |
InstanceConfiguration¶
The runtime configuration of instances (scaling units) of this service.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INSTANCECONFIGURATION() |
Getter for INSTANCECONFIGURATION |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENCRYPTIONCONFIGURATION() |
Getter for ENCRYPTIONCONFIGURATION |
HealthCheckConfiguration¶
The settings for the health check that App Runner performs to monitor the health of this service.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HEALTHCHECKCONFIGURATION() |
Getter for HEALTHCHECKCONFIGURATION |
AutoScalingConfigurationSummary¶
Summary information for the App Runner automatic scaling configuration resource that's associated with this service.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUTOSCALINGCONFSUMMARY() |
Getter for AUTOSCALINGCONFSUMMARY |
NetworkConfiguration¶
Configuration settings related to network traffic of the web application that this service runs.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NETWORKCONFIGURATION() |
Getter for NETWORKCONFIGURATION |
ObservabilityConfiguration¶
The observability configuration of this service.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OBSERVABILITYCONF() |
Getter for OBSERVABILITYCONFIGURATION |