Class Service

    • Method Detail

      • serviceName

        public final String serviceName()

        The customer-provided service name.

        Returns:
        The customer-provided service name.
      • serviceId

        public final String serviceId()

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

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

        public final String serviceArn()

        The Amazon Resource Name (ARN) of this service.

        Returns:
        The Amazon Resource Name (ARN) of this service.
      • serviceUrl

        public final String serviceUrl()

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

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

        public final Instant createdAt()

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

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

        public final Instant updatedAt()

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

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

        public final Instant deletedAt()

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

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

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

        If the service returns an enum value that is not available in the current SDK version, status will return ServiceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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

        See Also:
        ServiceStatus
      • statusAsString

        public final String statusAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, status will return ServiceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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

        See Also:
        ServiceStatus
      • sourceConfiguration

        public final SourceConfiguration sourceConfiguration()

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

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

        public final InstanceConfiguration instanceConfiguration()

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

        Returns:
        The runtime configuration of instances (scaling units) of this service.
      • encryptionConfiguration

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

        Returns:
        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.
      • healthCheckConfiguration

        public final HealthCheckConfiguration healthCheckConfiguration()

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

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

        public final AutoScalingConfigurationSummary autoScalingConfigurationSummary()

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

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

        public final NetworkConfiguration networkConfiguration()

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

        Returns:
        Configuration settings related to network traffic of the web application that this service runs.
      • observabilityConfiguration

        public final ServiceObservabilityConfiguration observabilityConfiguration()

        The observability configuration of this service.

        Returns:
        The observability configuration of this service.
      • serializableBuilderClass

        public static Class<? extends Service.Builder> serializableBuilderClass()
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)