Package software.amazon.awssdk.services.apprunner.model

Interface Service.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Service.Builder,Service>, SdkBuilder<Service.Builder,Service>, SdkPojo

Enclosing class:

Service

public static interface Service.Builder
extends SdkPojo, CopyableBuilder<Service.Builder,Service>

Method Summary

Modifier and Type	Method	Description
default Service.Builder	autoScalingConfigurationSummary(Consumer<AutoScalingConfigurationSummary.Builder> autoScalingConfigurationSummary)	Summary information for the App Runner automatic scaling configuration resource that's associated with this service.
Service.Builder	autoScalingConfigurationSummary(AutoScalingConfigurationSummary autoScalingConfigurationSummary)	Summary information for the App Runner automatic scaling configuration resource that's associated with this service.
Service.Builder	createdAt(Instant createdAt)	The time when the App Runner service was created.
Service.Builder	deletedAt(Instant deletedAt)	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.
Service.Builder	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.
Service.Builder	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.
Service.Builder	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.
Service.Builder	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.
Service.Builder	observabilityConfiguration(ServiceObservabilityConfiguration observabilityConfiguration)	The observability configuration of this service.
Service.Builder	serviceArn(String serviceArn)	The Amazon Resource Name (ARN) of this service.
Service.Builder	serviceId(String serviceId)	An ID that App Runner generated for this service.
Service.Builder	serviceName(String serviceName)	The customer-provided service name.
Service.Builder	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.
Service.Builder	sourceConfiguration(SourceConfiguration sourceConfiguration)	The source deployed to the App Runner service.
Service.Builder	status(String status)	The current state of the App Runner service.
Service.Builder	status(ServiceStatus status)	The current state of the App Runner service.
Service.Builder	updatedAt(Instant updatedAt)	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, sdkFieldNameToField, sdkFields

Method Detail

serviceName

Service.Builder serviceName(String 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

Service.Builder serviceId(String 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

Service.Builder serviceArn(String 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

Service.Builder serviceUrl(String 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

Service.Builder createdAt(Instant 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

Service.Builder updatedAt(Instant 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

Service.Builder deletedAt(Instant 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

Service.Builder status(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.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServiceStatus, ServiceStatus

status

Service.Builder status(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.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServiceStatus, ServiceStatus

sourceConfiguration

Service.Builder sourceConfiguration(SourceConfiguration 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 the SourceConfiguration.Builder avoiding the need to create one manually via SourceConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceConfiguration(SourceConfiguration).

Parameters:

sourceConfiguration - a consumer that will call methods on SourceConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

sourceConfiguration(SourceConfiguration)

instanceConfiguration

Service.Builder instanceConfiguration(InstanceConfiguration 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 the InstanceConfiguration.Builder avoiding the need to create one manually via InstanceConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instanceConfiguration(InstanceConfiguration).

Parameters:

instanceConfiguration - a consumer that will call methods on InstanceConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

instanceConfiguration(InstanceConfiguration)

encryptionConfiguration

Service.Builder 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. 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 the EncryptionConfiguration.Builder avoiding the need to create one manually via EncryptionConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionConfiguration(EncryptionConfiguration).

Parameters:

encryptionConfiguration - a consumer that will call methods on EncryptionConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

encryptionConfiguration(EncryptionConfiguration)

healthCheckConfiguration

Service.Builder healthCheckConfiguration(HealthCheckConfiguration 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 the HealthCheckConfiguration.Builder avoiding the need to create one manually via HealthCheckConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to healthCheckConfiguration(HealthCheckConfiguration).

Parameters:

healthCheckConfiguration - a consumer that will call methods on HealthCheckConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

healthCheckConfiguration(HealthCheckConfiguration)

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 the AutoScalingConfigurationSummary.Builder avoiding the need to create one manually via AutoScalingConfigurationSummary.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to autoScalingConfigurationSummary(AutoScalingConfigurationSummary).

Parameters:

autoScalingConfigurationSummary - a consumer that will call methods on AutoScalingConfigurationSummary.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

autoScalingConfigurationSummary(AutoScalingConfigurationSummary)

networkConfiguration

Service.Builder networkConfiguration(NetworkConfiguration 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 the NetworkConfiguration.Builder avoiding the need to create one manually via NetworkConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to networkConfiguration(NetworkConfiguration).

Parameters:

networkConfiguration - a consumer that will call methods on NetworkConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

networkConfiguration(NetworkConfiguration)

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 the ServiceObservabilityConfiguration.Builder avoiding the need to create one manually via ServiceObservabilityConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to observabilityConfiguration(ServiceObservabilityConfiguration).

Parameters:

observabilityConfiguration - a consumer that will call methods on ServiceObservabilityConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

observabilityConfiguration(ServiceObservabilityConfiguration)