Class UpdateDistributionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.lightsail.model.LightsailRequest
software.amazon.awssdk.services.lightsail.model.UpdateDistributionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateDistributionRequest.Builder,UpdateDistributionRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateDistributionRequest extends LightsailRequest implements ToCopyableBuilder<UpdateDistributionRequest.Builder,UpdateDistributionRequest>

  • Method Details

    • distributionName

      public final String distributionName()

      The name of the distribution to update.

      Use the GetDistributions action to get a list of distribution names that you can specify.

      Returns:
      The name of the distribution to update.

      Use the GetDistributions action to get a list of distribution names that you can specify.

    • origin

      public final InputOrigin origin()

      An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.

      The distribution pulls, caches, and serves content from the origin.

      Returns:
      An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.

      The distribution pulls, caches, and serves content from the origin.

    • defaultCacheBehavior

      public final CacheBehavior defaultCacheBehavior()

      An object that describes the default cache behavior for the distribution.

      Returns:
      An object that describes the default cache behavior for the distribution.

    • cacheBehaviorSettings

      public final CacheSettings cacheBehaviorSettings()

      An object that describes the cache behavior settings for the distribution.

      The cacheBehaviorSettings specified in your UpdateDistributionRequest will replace your distribution's existing settings.

      Returns:
      An object that describes the cache behavior settings for the distribution.

      The cacheBehaviorSettings specified in your UpdateDistributionRequest will replace your distribution's existing settings.

    • hasCacheBehaviors

      public final boolean hasCacheBehaviors()
      For responses, this returns true if the service returned a value for the CacheBehaviors 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.

    • cacheBehaviors

      public final List<CacheBehaviorPerPath> cacheBehaviors()

      An array of objects that describe the per-path cache behavior for the distribution.

      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 hasCacheBehaviors() method.

      Returns:
      An array of objects that describe the per-path cache behavior for the distribution.

    • isEnabled

      public final Boolean isEnabled()

      Indicates whether to enable the distribution.

      Returns:
      Indicates whether to enable the distribution.

    • viewerMinimumTlsProtocolVersion

      public final ViewerMinimumTlsProtocolVersionEnum viewerMinimumTlsProtocolVersion()

      Use this parameter to update the minimum TLS protocol version for the SSL/TLS certificate that's attached to the distribution.

      If the service returns an enum value that is not available in the current SDK version, viewerMinimumTlsProtocolVersion will return ViewerMinimumTlsProtocolVersionEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from viewerMinimumTlsProtocolVersionAsString().

      Returns:
      Use this parameter to update the minimum TLS protocol version for the SSL/TLS certificate that's attached to the distribution.
      See Also:

    • viewerMinimumTlsProtocolVersionAsString

      public final String viewerMinimumTlsProtocolVersionAsString()

      Use this parameter to update the minimum TLS protocol version for the SSL/TLS certificate that's attached to the distribution.

      If the service returns an enum value that is not available in the current SDK version, viewerMinimumTlsProtocolVersion will return ViewerMinimumTlsProtocolVersionEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from viewerMinimumTlsProtocolVersionAsString().

      Returns:
      Use this parameter to update the minimum TLS protocol version for the SSL/TLS certificate that's attached to the distribution.
      See Also:

    • certificateName

      public final String certificateName()

      The name of the SSL/TLS certificate that you want to attach to the distribution.

      Only certificates with a status of ISSUED can be attached to a distribution.

      Use the GetCertificates action to get a list of certificate names that you can specify.

      Returns:
      The name of the SSL/TLS certificate that you want to attach to the distribution.

      Only certificates with a status of ISSUED can be attached to a distribution.

      Use the GetCertificates action to get a list of certificate names that you can specify.

    • useDefaultCertificate

      public final Boolean useDefaultCertificate()

      Indicates whether the default SSL/TLS certificate is attached to the distribution. The default value is true. When true, the distribution uses the default domain name such as d111111abcdef8.cloudfront.net.

      Set this value to false to attach a new certificate to the distribution.

      Returns:
      Indicates whether the default SSL/TLS certificate is attached to the distribution. The default value is true. When true, the distribution uses the default domain name such as d111111abcdef8.cloudfront.net.

      Set this value to false to attach a new certificate to the distribution.

    • enablePrivateOriginAccess

      public final Boolean enablePrivateOriginAccess()

      Specifies whether to enable private origin access for the distribution. With private origin access, the distribution can serve objects that aren't publicly accessible from a Lightsail bucket.

      Lightsail grants the distribution permission to read the bucket's objects. Enabling private origin access doesn't change the bucket's access settings, and you can still retrieve publicly accessible objects directly from the bucket's endpoint.

      When you include this parameter, you must also include the origin parameter with the resource name, even if the origin is not changing.

      You can enable private origin access only when the distribution's origin is a Lightsail bucket. If the origin is another resource type, the request fails.

      Returns:
      Specifies whether to enable private origin access for the distribution. With private origin access, the distribution can serve objects that aren't publicly accessible from a Lightsail bucket.

      Lightsail grants the distribution permission to read the bucket's objects. Enabling private origin access doesn't change the bucket's access settings, and you can still retrieve publicly accessible objects directly from the bucket's endpoint.

      When you include this parameter, you must also include the origin parameter with the resource name, even if the origin is not changing.

      You can enable private origin access only when the distribution's origin is a Lightsail bucket. If the origin is another resource type, the request fails.

    • defaultRootObject

      public final String defaultRootObject()

      The object (for example, index.html) that the distribution returns when a viewer requests the root URL of the distribution (/) instead of a specific object. The object that you specify must be available from the origin.

      Returns:
      The object (for example, index.html) that the distribution returns when a viewer requests the root URL of the distribution (/) instead of a specific object. The object that you specify must be available from the origin.

    • hasCustomErrorResponses

      public final boolean hasCustomErrorResponses()
      For responses, this returns true if the service returned a value for the CustomErrorResponses 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.

    • customErrorResponses

      public final List<DistributionCustomErrorResponse> customErrorResponses()

      An array of objects that describe the custom error responses for the distribution. With a custom error response, you can specify the page to return when the origin responds with a given HTTP error code. You can also specify the HTTP status code to send to the viewer.

      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 hasCustomErrorResponses() method.

      Returns:
      An array of objects that describe the custom error responses for the distribution. With a custom error response, you can specify the page to return when the origin responds with a given HTTP error code. You can also specify the HTTP status code to send to the viewer.

    • toBuilder

      public UpdateDistributionRequest.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<UpdateDistributionRequest.Builder,UpdateDistributionRequest>
      Specified by:
      toBuilder in class LightsailRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateDistributionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateDistributionRequest.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.