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>

  • Method Details

    • 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 the isEmpty() 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/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

      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()
      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 interface ToCopyableBuilder<CreateServiceRequest.Builder,CreateServiceRequest>
      Specified by:
      toBuilder in class AppRunnerRequest
      Returns:
      a builder for type T

    • builder

      public static CreateServiceRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateServiceRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.