Class CreateServiceRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.apprunner.model.AppRunnerRequest
-
- software.amazon.awssdk.services.apprunner.model.CreateServiceRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateServiceRequest.Builder,CreateServiceRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateServiceRequest extends AppRunnerRequest implements ToCopyableBuilder<CreateServiceRequest.Builder,CreateServiceRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateServiceRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringautoScalingConfigurationArn()The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service.static CreateServiceRequest.Builderbuilder()EncryptionConfigurationencryptionConfiguration()An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.HealthCheckConfigurationhealthCheckConfiguration()The settings for the health check that App Runner performs to monitor the health of the App Runner service.InstanceConfigurationinstanceConfiguration()The runtime configuration of instances (scaling units) of your service.NetworkConfigurationnetworkConfiguration()Configuration settings related to network traffic of the web application that the App Runner service runs.ServiceObservabilityConfigurationobservabilityConfiguration()The observability configuration of your service.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateServiceRequest.Builder>serializableBuilderClass()StringserviceName()A name for the App Runner service.SourceConfigurationsourceConfiguration()The source to deploy to the App Runner service.List<Tag>tags()An optional list of metadata items that you can associate with the App Runner service resource.CreateServiceRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
serviceName
public final 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.
- Returns:
- 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.
-
sourceConfiguration
public final SourceConfiguration sourceConfiguration()
The source to deploy to the App Runner service. It can be a code or an image repository.
- Returns:
- The source to deploy 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 your service.
- Returns:
- The runtime configuration of instances (scaling units) of your service.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tags
public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()method.- Returns:
- An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair.
-
encryptionConfiguration
public final 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.
- Returns:
- 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.
-
healthCheckConfiguration
public final HealthCheckConfiguration healthCheckConfiguration()
The settings for the health check that App Runner performs to monitor the health of the App Runner service.
- Returns:
- The settings for the health check that App Runner performs to monitor the health of the App Runner service.
-
autoScalingConfigurationArn
public final 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/3Specify just the name to associate the latest revision. For example:
arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability- Returns:
- 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/3Specify just the name to associate the latest revision. For example:
arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability
-
networkConfiguration
public final NetworkConfiguration networkConfiguration()
Configuration settings related to network traffic of the web application that the App Runner service runs.
- Returns:
- Configuration settings related to network traffic of the web application that the App Runner service runs.
-
observabilityConfiguration
public final ServiceObservabilityConfiguration observabilityConfiguration()
The observability configuration of your service.
- Returns:
- The observability configuration of your service.
-
toBuilder
public CreateServiceRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateServiceRequest.Builder,CreateServiceRequest>- Specified by:
toBuilderin classAppRunnerRequest
-
builder
public static CreateServiceRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateServiceRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-