Interface CreateServiceRequest.Builder

All Superinterfaces:

AppRunnerRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateServiceRequest.Builder,CreateServiceRequest>, SdkBuilder<CreateServiceRequest.Builder,CreateServiceRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateServiceRequest

@Mutable
@NotThreadSafe
public static interface CreateServiceRequest.Builder
extends AppRunnerRequest.Builder, SdkPojo, CopyableBuilder<CreateServiceRequest.Builder,CreateServiceRequest>

Method Summary

Modifier and Type	Method	Description
CreateServiceRequest.Builder	autoScalingConfigurationArn(String autoScalingConfigurationArn)	The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service.
default CreateServiceRequest.Builder	encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)	An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs.
CreateServiceRequest.Builder	encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)	An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs.
default CreateServiceRequest.Builder	healthCheckConfiguration(Consumer<HealthCheckConfiguration.Builder> healthCheckConfiguration)	The settings for the health check that App Runner performs to monitor the health of the App Runner service.
CreateServiceRequest.Builder	healthCheckConfiguration(HealthCheckConfiguration healthCheckConfiguration)	The settings for the health check that App Runner performs to monitor the health of the App Runner service.
default CreateServiceRequest.Builder	instanceConfiguration(Consumer<InstanceConfiguration.Builder> instanceConfiguration)	The runtime configuration of instances (scaling units) of your service.
CreateServiceRequest.Builder	instanceConfiguration(InstanceConfiguration instanceConfiguration)	The runtime configuration of instances (scaling units) of your service.
default CreateServiceRequest.Builder	networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)	Configuration settings related to network traffic of the web application that the App Runner service runs.
CreateServiceRequest.Builder	networkConfiguration(NetworkConfiguration networkConfiguration)	Configuration settings related to network traffic of the web application that the App Runner service runs.
default CreateServiceRequest.Builder	observabilityConfiguration(Consumer<ServiceObservabilityConfiguration.Builder> observabilityConfiguration)	The observability configuration of your service.
CreateServiceRequest.Builder	observabilityConfiguration(ServiceObservabilityConfiguration observabilityConfiguration)	The observability configuration of your service.
CreateServiceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateServiceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateServiceRequest.Builder	serviceName(String serviceName)	A name for the App Runner service.
default CreateServiceRequest.Builder	sourceConfiguration(Consumer<SourceConfiguration.Builder> sourceConfiguration)	The source to deploy to the App Runner service.
CreateServiceRequest.Builder	sourceConfiguration(SourceConfiguration sourceConfiguration)	The source to deploy to the App Runner service.
CreateServiceRequest.Builder	tags(Collection<Tag> tags)	An optional list of metadata items that you can associate with the App Runner service resource.
CreateServiceRequest.Builder	tags(Consumer<Tag.Builder>... tags)	An optional list of metadata items that you can associate with the App Runner service resource.
CreateServiceRequest.Builder	tags(Tag... tags)	An optional list of metadata items that you can associate with the App Runner service resource.

Methods inherited from interface software.amazon.awssdk.services.apprunner.model.AppRunnerRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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 Details

serviceName

CreateServiceRequest.Builder serviceName(String serviceName)

A name for the App Runner service. It must be unique across all the running App Runner services in your Amazon Web Services account in the Amazon Web Services Region.

Parameters:

serviceName - A name for the App Runner service. It must be unique across all the running App Runner services in your Amazon Web Services account in the Amazon Web Services Region.

Returns:

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

sourceConfiguration

CreateServiceRequest.Builder sourceConfiguration(SourceConfiguration sourceConfiguration)

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

Parameters:

sourceConfiguration - The source to deploy 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 CreateServiceRequest.Builder sourceConfiguration(Consumer<SourceConfiguration.Builder> sourceConfiguration)

The source to deploy 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

CreateServiceRequest.Builder instanceConfiguration(InstanceConfiguration instanceConfiguration)

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

Parameters:

instanceConfiguration - The runtime configuration of instances (scaling units) of your service.

Returns:

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

instanceConfiguration

default CreateServiceRequest.Builder instanceConfiguration(Consumer<InstanceConfiguration.Builder> instanceConfiguration)

The runtime configuration of instances (scaling units) of your 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)

tags

CreateServiceRequest.Builder tags(Collection<Tag> tags)

An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair.

Parameters:

tags - An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair.

Returns:

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

tags

CreateServiceRequest.Builder tags(Tag... tags)

An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair.

Parameters:

tags - An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair.

Returns:

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

tags

CreateServiceRequest.Builder tags(Consumer<Tag.Builder>... tags)

An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

• tags(java.util.Collection<Tag>)

encryptionConfiguration

CreateServiceRequest.Builder encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. By default, App Runner uses an Amazon Web Services managed key.

Parameters:

encryptionConfiguration - An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. By default, App Runner uses an Amazon Web Services managed key.

Returns:

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

encryptionConfiguration

default CreateServiceRequest.Builder encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)

An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. By default, App Runner uses 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

CreateServiceRequest.Builder healthCheckConfiguration(HealthCheckConfiguration healthCheckConfiguration)

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

Parameters:

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

Returns:

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

healthCheckConfiguration

default CreateServiceRequest.Builder healthCheckConfiguration(Consumer<HealthCheckConfiguration.Builder> healthCheckConfiguration)

The settings for the health check that App Runner performs to monitor the health of the App Runner 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)

autoScalingConfigurationArn

CreateServiceRequest.Builder autoScalingConfigurationArn(String autoScalingConfigurationArn)

The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service. If not provided, App Runner associates the latest revision of a default auto scaling configuration.

Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3

Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability

Parameters:

autoScalingConfigurationArn - The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service. If not provided, App Runner associates the latest revision of a default auto scaling configuration.

Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3

Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability

Returns:

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

networkConfiguration

CreateServiceRequest.Builder networkConfiguration(NetworkConfiguration networkConfiguration)

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

Parameters:

networkConfiguration - Configuration settings related to network traffic of the web application that the App Runner service runs.

Returns:

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

networkConfiguration

default CreateServiceRequest.Builder networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)

Configuration settings related to network traffic of the web application that the App Runner 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

CreateServiceRequest.Builder observabilityConfiguration(ServiceObservabilityConfiguration observabilityConfiguration)

The observability configuration of your service.

Parameters:

observabilityConfiguration - The observability configuration of your service.

Returns:

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

observabilityConfiguration

default CreateServiceRequest.Builder observabilityConfiguration(Consumer<ServiceObservabilityConfiguration.Builder> observabilityConfiguration)

The observability configuration of your 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)

overrideConfiguration

CreateServiceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateServiceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.