Interface Service.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Service.Builder,
,Service> SdkBuilder<Service.Builder,
,Service> SdkPojo
- Enclosing class:
Service
-
Method Summary
Modifier and TypeMethodDescriptiondefault Service.Builder
autoScalingConfigurationSummary
(Consumer<AutoScalingConfigurationSummary.Builder> autoScalingConfigurationSummary) Summary information for the App Runner automatic scaling configuration resource that's associated with this service.autoScalingConfigurationSummary
(AutoScalingConfigurationSummary autoScalingConfigurationSummary) Summary information for the App Runner automatic scaling configuration resource that's associated with this service.The time when the App Runner service was created.The time when the App Runner service was deleted.default Service.Builder
encryptionConfiguration
(Consumer<EncryptionConfiguration.Builder> 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.encryptionConfiguration
(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.default Service.Builder
healthCheckConfiguration
(Consumer<HealthCheckConfiguration.Builder> healthCheckConfiguration) The settings for the health check that App Runner performs to monitor the health of this service.healthCheckConfiguration
(HealthCheckConfiguration healthCheckConfiguration) The settings for the health check that App Runner performs to monitor the health of this service.default Service.Builder
instanceConfiguration
(Consumer<InstanceConfiguration.Builder> instanceConfiguration) The runtime configuration of instances (scaling units) of this service.instanceConfiguration
(InstanceConfiguration instanceConfiguration) The runtime configuration of instances (scaling units) of this service.default Service.Builder
networkConfiguration
(Consumer<NetworkConfiguration.Builder> networkConfiguration) Configuration settings related to network traffic of the web application that this service runs.networkConfiguration
(NetworkConfiguration networkConfiguration) Configuration settings related to network traffic of the web application that this service runs.default Service.Builder
observabilityConfiguration
(Consumer<ServiceObservabilityConfiguration.Builder> observabilityConfiguration) The observability configuration of this service.observabilityConfiguration
(ServiceObservabilityConfiguration observabilityConfiguration) The observability configuration of this service.serviceArn
(String serviceArn) The Amazon Resource Name (ARN) of this service.An ID that App Runner generated for this service.serviceName
(String serviceName) The customer-provided service name.serviceUrl
(String serviceUrl) A subdomain URL that App Runner generated for this service.default Service.Builder
sourceConfiguration
(Consumer<SourceConfiguration.Builder> sourceConfiguration) The source deployed to the App Runner service.sourceConfiguration
(SourceConfiguration sourceConfiguration) The source deployed to the App Runner service.The current state of the App Runner service.status
(ServiceStatus status) The current state of the App Runner service.The time when the App Runner service was last updated at.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
serviceName
The customer-provided service name.
- Parameters:
serviceName
- The customer-provided service name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serviceId
An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.
- Parameters:
serviceId
- An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serviceArn
The Amazon Resource Name (ARN) of this service.
- Parameters:
serviceArn
- The Amazon Resource Name (ARN) of this service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serviceUrl
A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.
- Parameters:
serviceUrl
- A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdAt
The time when the App Runner service was created. It's in the Unix time stamp format.
- Parameters:
createdAt
- The time when the App Runner service was created. It's in the Unix time stamp format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
updatedAt
The time when the App Runner service was last updated at. It's in the Unix time stamp format.
- Parameters:
updatedAt
- The time when the App Runner service was last updated at. It's in the Unix time stamp format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deletedAt
The time when the App Runner service was deleted. It's in the Unix time stamp format.
- Parameters:
deletedAt
- The time when the App Runner service was deleted. It's in the Unix time stamp format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
sourceConfiguration
The source deployed to the App Runner service. It can be a code or an image repository.
- Parameters:
sourceConfiguration
- The source deployed to the App Runner service. It can be a code or an image repository.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceConfiguration
default Service.Builder sourceConfiguration(Consumer<SourceConfiguration.Builder> sourceConfiguration) The source deployed to the App Runner service. It can be a code or an image repository.
This is a convenience method that creates an instance of theSourceConfiguration.Builder
avoiding the need to create one manually viaSourceConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosourceConfiguration(SourceConfiguration)
.- Parameters:
sourceConfiguration
- a consumer that will call methods onSourceConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
instanceConfiguration
The runtime configuration of instances (scaling units) of this service.
- Parameters:
instanceConfiguration
- The runtime configuration of instances (scaling units) of this service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceConfiguration
default Service.Builder instanceConfiguration(Consumer<InstanceConfiguration.Builder> instanceConfiguration) The runtime configuration of instances (scaling units) of this service.
This is a convenience method that creates an instance of theInstanceConfiguration.Builder
avoiding the need to create one manually viaInstanceConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinstanceConfiguration(InstanceConfiguration)
.- Parameters:
instanceConfiguration
- a consumer that will call methods onInstanceConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
encryptionConfiguration
default Service.Builder encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> 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.
This is a convenience method that creates an instance of theEncryptionConfiguration.Builder
avoiding the need to create one manually viaEncryptionConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toencryptionConfiguration(EncryptionConfiguration)
.- Parameters:
encryptionConfiguration
- a consumer that will call methods onEncryptionConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
healthCheckConfiguration
The settings for the health check that App Runner performs to monitor the health of this service.
- Parameters:
healthCheckConfiguration
- The settings for the health check that App Runner performs to monitor the health of this service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
healthCheckConfiguration
default Service.Builder healthCheckConfiguration(Consumer<HealthCheckConfiguration.Builder> healthCheckConfiguration) The settings for the health check that App Runner performs to monitor the health of this service.
This is a convenience method that creates an instance of theHealthCheckConfiguration.Builder
avoiding the need to create one manually viaHealthCheckConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tohealthCheckConfiguration(HealthCheckConfiguration)
.- Parameters:
healthCheckConfiguration
- a consumer that will call methods onHealthCheckConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
autoScalingConfigurationSummary
Service.Builder autoScalingConfigurationSummary(AutoScalingConfigurationSummary autoScalingConfigurationSummary) Summary information for the App Runner automatic scaling configuration resource that's associated with this service.
- Parameters:
autoScalingConfigurationSummary
- Summary information for the App Runner automatic scaling configuration resource that's associated with this service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoScalingConfigurationSummary
default Service.Builder autoScalingConfigurationSummary(Consumer<AutoScalingConfigurationSummary.Builder> autoScalingConfigurationSummary) Summary information for the App Runner automatic scaling configuration resource that's associated with this service.
This is a convenience method that creates an instance of theAutoScalingConfigurationSummary.Builder
avoiding the need to create one manually viaAutoScalingConfigurationSummary.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toautoScalingConfigurationSummary(AutoScalingConfigurationSummary)
.- Parameters:
autoScalingConfigurationSummary
- a consumer that will call methods onAutoScalingConfigurationSummary.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
networkConfiguration
Configuration settings related to network traffic of the web application that this service runs.
- Parameters:
networkConfiguration
- Configuration settings related to network traffic of the web application that this service runs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
networkConfiguration
default Service.Builder networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration) Configuration settings related to network traffic of the web application that this service runs.
This is a convenience method that creates an instance of theNetworkConfiguration.Builder
avoiding the need to create one manually viaNetworkConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonetworkConfiguration(NetworkConfiguration)
.- Parameters:
networkConfiguration
- a consumer that will call methods onNetworkConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
observabilityConfiguration
Service.Builder observabilityConfiguration(ServiceObservabilityConfiguration observabilityConfiguration) The observability configuration of this service.
- Parameters:
observabilityConfiguration
- The observability configuration of this service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
observabilityConfiguration
default Service.Builder observabilityConfiguration(Consumer<ServiceObservabilityConfiguration.Builder> observabilityConfiguration) The observability configuration of this service.
This is a convenience method that creates an instance of theServiceObservabilityConfiguration.Builder
avoiding the need to create one manually viaServiceObservabilityConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toobservabilityConfiguration(ServiceObservabilityConfiguration)
.- Parameters:
observabilityConfiguration
- a consumer that will call methods onServiceObservabilityConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-