@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Service extends Object implements Serializable, Cloneable, StructuredPojo
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 and Description |
---|
Service() |
Modifier and Type | Method and Description |
---|---|
Service |
clone() |
boolean |
equals(Object obj) |
AutoScalingConfigurationSummary |
getAutoScalingConfigurationSummary()
Summary information for the App Runner automatic scaling configuration resource that's associated with this
service.
|
Date |
getCreatedAt()
The time when the App Runner service was created.
|
Date |
getDeletedAt()
The time when the App Runner service was deleted.
|
EncryptionConfiguration |
getEncryptionConfiguration()
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.
|
HealthCheckConfiguration |
getHealthCheckConfiguration()
The settings for the health check that App Runner performs to monitor the health of this service.
|
InstanceConfiguration |
getInstanceConfiguration()
The runtime configuration of instances (scaling units) of this service.
|
NetworkConfiguration |
getNetworkConfiguration()
Configuration settings related to network traffic of the web application that this service runs.
|
ServiceObservabilityConfiguration |
getObservabilityConfiguration()
The observability configuration of this service.
|
String |
getServiceArn()
The Amazon Resource Name (ARN) of this service.
|
String |
getServiceId()
An ID that App Runner generated for this service.
|
String |
getServiceName()
The customer-provided service name.
|
String |
getServiceUrl()
A subdomain URL that App Runner generated for this service.
|
SourceConfiguration |
getSourceConfiguration()
The source deployed to the App Runner service.
|
String |
getStatus()
The current state of the App Runner service.
|
Date |
getUpdatedAt()
The time when the App Runner service was last updated at.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAutoScalingConfigurationSummary(AutoScalingConfigurationSummary autoScalingConfigurationSummary)
Summary information for the App Runner automatic scaling configuration resource that's associated with this
service.
|
void |
setCreatedAt(Date createdAt)
The time when the App Runner service was created.
|
void |
setDeletedAt(Date deletedAt)
The time when the App Runner service was deleted.
|
void |
setEncryptionConfiguration(EncryptionConfiguration 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.
|
void |
setHealthCheckConfiguration(HealthCheckConfiguration healthCheckConfiguration)
The settings for the health check that App Runner performs to monitor the health of this service.
|
void |
setInstanceConfiguration(InstanceConfiguration instanceConfiguration)
The runtime configuration of instances (scaling units) of this service.
|
void |
setNetworkConfiguration(NetworkConfiguration networkConfiguration)
Configuration settings related to network traffic of the web application that this service runs.
|
void |
setObservabilityConfiguration(ServiceObservabilityConfiguration observabilityConfiguration)
The observability configuration of this service.
|
void |
setServiceArn(String serviceArn)
The Amazon Resource Name (ARN) of this service.
|
void |
setServiceId(String serviceId)
An ID that App Runner generated for this service.
|
void |
setServiceName(String serviceName)
The customer-provided service name.
|
void |
setServiceUrl(String serviceUrl)
A subdomain URL that App Runner generated for this service.
|
void |
setSourceConfiguration(SourceConfiguration sourceConfiguration)
The source deployed to the App Runner service.
|
void |
setStatus(String status)
The current state of the App Runner service.
|
void |
setUpdatedAt(Date updatedAt)
The time when the App Runner service was last updated at.
|
String |
toString()
Returns a string representation of this object.
|
Service |
withAutoScalingConfigurationSummary(AutoScalingConfigurationSummary autoScalingConfigurationSummary)
Summary information for the App Runner automatic scaling configuration resource that's associated with this
service.
|
Service |
withCreatedAt(Date createdAt)
The time when the App Runner service was created.
|
Service |
withDeletedAt(Date deletedAt)
The time when the App Runner service was deleted.
|
Service |
withEncryptionConfiguration(EncryptionConfiguration 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.
|
Service |
withHealthCheckConfiguration(HealthCheckConfiguration healthCheckConfiguration)
The settings for the health check that App Runner performs to monitor the health of this service.
|
Service |
withInstanceConfiguration(InstanceConfiguration instanceConfiguration)
The runtime configuration of instances (scaling units) of this service.
|
Service |
withNetworkConfiguration(NetworkConfiguration networkConfiguration)
Configuration settings related to network traffic of the web application that this service runs.
|
Service |
withObservabilityConfiguration(ServiceObservabilityConfiguration observabilityConfiguration)
The observability configuration of this service.
|
Service |
withServiceArn(String serviceArn)
The Amazon Resource Name (ARN) of this service.
|
Service |
withServiceId(String serviceId)
An ID that App Runner generated for this service.
|
Service |
withServiceName(String serviceName)
The customer-provided service name.
|
Service |
withServiceUrl(String serviceUrl)
A subdomain URL that App Runner generated for this service.
|
Service |
withSourceConfiguration(SourceConfiguration sourceConfiguration)
The source deployed to the App Runner service.
|
Service |
withStatus(ServiceStatus status)
The current state of the App Runner service.
|
Service |
withStatus(String status)
The current state of the App Runner service.
|
Service |
withUpdatedAt(Date updatedAt)
The time when the App Runner service was last updated at.
|
public void setServiceName(String serviceName)
The customer-provided service name.
serviceName
- The customer-provided service name.public String getServiceName()
The customer-provided service name.
public Service withServiceName(String serviceName)
The customer-provided service name.
serviceName
- The customer-provided service name.public void setServiceId(String serviceId)
An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.
serviceId
- An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.public String getServiceId()
An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.
public Service withServiceId(String serviceId)
An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.
serviceId
- An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.public void setServiceArn(String serviceArn)
The Amazon Resource Name (ARN) of this service.
serviceArn
- The Amazon Resource Name (ARN) of this service.public String getServiceArn()
The Amazon Resource Name (ARN) of this service.
public Service withServiceArn(String serviceArn)
The Amazon Resource Name (ARN) of this service.
serviceArn
- The Amazon Resource Name (ARN) of this service.public void setServiceUrl(String serviceUrl)
A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.
serviceUrl
- A subdomain URL that App Runner generated for this service. You can use this URL to access your service
web application.public String getServiceUrl()
A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.
public Service withServiceUrl(String serviceUrl)
A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.
serviceUrl
- A subdomain URL that App Runner generated for this service. You can use this URL to access your service
web application.public void setCreatedAt(Date createdAt)
The time when the App Runner service was created. It's in the Unix time stamp format.
createdAt
- The time when the App Runner service was created. It's in the Unix time stamp format.public Date getCreatedAt()
The time when the App Runner service was created. It's in the Unix time stamp format.
public Service withCreatedAt(Date createdAt)
The time when the App Runner service was created. It's in the Unix time stamp format.
createdAt
- The time when the App Runner service was created. It's in the Unix time stamp format.public void setUpdatedAt(Date updatedAt)
The time when the App Runner service was last updated at. It's in the Unix time stamp format.
updatedAt
- The time when the App Runner service was last updated at. It's in the Unix time stamp format.public Date getUpdatedAt()
The time when the App Runner service was last updated at. It's in the Unix time stamp format.
public Service withUpdatedAt(Date updatedAt)
The time when the App Runner service was last updated at. It's in the Unix time stamp format.
updatedAt
- The time when the App Runner service was last updated at. It's in the Unix time stamp format.public void setDeletedAt(Date deletedAt)
The time when the App Runner service was deleted. It's in the Unix time stamp format.
deletedAt
- The time when the App Runner service was deleted. It's in the Unix time stamp format.public Date getDeletedAt()
The time when the App Runner service was deleted. It's in the Unix time stamp format.
public Service withDeletedAt(Date deletedAt)
The time when the App Runner service was deleted. It's in the Unix time stamp format.
deletedAt
- The time when the App Runner service was deleted. It's in the Unix time stamp format.public void setStatus(String 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 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.
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 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.
ServiceStatus
public String getStatus()
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.
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.
ServiceStatus
public Service withStatus(String 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 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.
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 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.
ServiceStatus
public Service withStatus(ServiceStatus 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 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.
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 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.
ServiceStatus
public void setSourceConfiguration(SourceConfiguration sourceConfiguration)
The source deployed to the App Runner service. It can be a code or an image repository.
sourceConfiguration
- The source deployed to the App Runner service. It can be a code or an image repository.public SourceConfiguration getSourceConfiguration()
The source deployed to the App Runner service. It can be a code or an image repository.
public Service withSourceConfiguration(SourceConfiguration sourceConfiguration)
The source deployed to the App Runner service. It can be a code or an image repository.
sourceConfiguration
- The source deployed to the App Runner service. It can be a code or an image repository.public void setInstanceConfiguration(InstanceConfiguration instanceConfiguration)
The runtime configuration of instances (scaling units) of this service.
instanceConfiguration
- The runtime configuration of instances (scaling units) of this service.public InstanceConfiguration getInstanceConfiguration()
The runtime configuration of instances (scaling units) of this service.
public Service withInstanceConfiguration(InstanceConfiguration instanceConfiguration)
The runtime configuration of instances (scaling units) of this service.
instanceConfiguration
- The runtime configuration of instances (scaling units) of this service.public void setEncryptionConfiguration(EncryptionConfiguration 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.
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.public EncryptionConfiguration getEncryptionConfiguration()
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.
public Service withEncryptionConfiguration(EncryptionConfiguration 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.
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.public void setHealthCheckConfiguration(HealthCheckConfiguration healthCheckConfiguration)
The settings for the health check that App Runner performs to monitor the health of this service.
healthCheckConfiguration
- The settings for the health check that App Runner performs to monitor the health of this service.public HealthCheckConfiguration getHealthCheckConfiguration()
The settings for the health check that App Runner performs to monitor the health of this service.
public Service withHealthCheckConfiguration(HealthCheckConfiguration healthCheckConfiguration)
The settings for the health check that App Runner performs to monitor the health of this service.
healthCheckConfiguration
- The settings for the health check that App Runner performs to monitor the health of this service.public void setAutoScalingConfigurationSummary(AutoScalingConfigurationSummary autoScalingConfigurationSummary)
Summary information for the App Runner automatic scaling configuration resource that's associated with this service.
autoScalingConfigurationSummary
- Summary information for the App Runner automatic scaling configuration resource that's associated with
this service.public AutoScalingConfigurationSummary getAutoScalingConfigurationSummary()
Summary information for the App Runner automatic scaling configuration resource that's associated with this service.
public Service withAutoScalingConfigurationSummary(AutoScalingConfigurationSummary autoScalingConfigurationSummary)
Summary information for the App Runner automatic scaling configuration resource that's associated with this service.
autoScalingConfigurationSummary
- Summary information for the App Runner automatic scaling configuration resource that's associated with
this service.public void setNetworkConfiguration(NetworkConfiguration networkConfiguration)
Configuration settings related to network traffic of the web application that this service runs.
networkConfiguration
- Configuration settings related to network traffic of the web application that this service runs.public NetworkConfiguration getNetworkConfiguration()
Configuration settings related to network traffic of the web application that this service runs.
public Service withNetworkConfiguration(NetworkConfiguration networkConfiguration)
Configuration settings related to network traffic of the web application that this service runs.
networkConfiguration
- Configuration settings related to network traffic of the web application that this service runs.public void setObservabilityConfiguration(ServiceObservabilityConfiguration observabilityConfiguration)
The observability configuration of this service.
observabilityConfiguration
- The observability configuration of this service.public ServiceObservabilityConfiguration getObservabilityConfiguration()
The observability configuration of this service.
public Service withObservabilityConfiguration(ServiceObservabilityConfiguration observabilityConfiguration)
The observability configuration of this service.
observabilityConfiguration
- The observability configuration of this service.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.