Class CreateServiceRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateServiceRequest.Builder,
CreateServiceRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service.static CreateServiceRequest.Builder
builder()
final 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.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final HealthCheckConfiguration
The settings for the health check that App Runner performs to monitor the health of the App Runner service.final InstanceConfiguration
The runtime configuration of instances (scaling units) of your service.final NetworkConfiguration
Configuration settings related to network traffic of the web application that the App Runner service runs.The observability configuration of your service.static Class
<? extends CreateServiceRequest.Builder> final String
A name for the App Runner service.final SourceConfiguration
The source to deploy to the App Runner service.tags()
An optional list of metadata items that you can associate with the App Runner service resource.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
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
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
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
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:
- 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
-
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
The observability configuration of your service.
- Returns:
- The observability configuration of your service.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateServiceRequest.Builder,
CreateServiceRequest> - Specified by:
toBuilder
in classAppRunnerRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-