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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceUpdateDistributionRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UpdateDistributionRequest.Builderbuilder()List<CacheBehaviorPerPath>cacheBehaviors()An array of objects that describe the per-path cache behavior for the distribution.CacheSettingscacheBehaviorSettings()An object that describes the cache behavior settings for the distribution.StringcertificateName()The name of the SSL/TLS certificate that you want to attach to the distribution.CacheBehaviordefaultCacheBehavior()An object that describes the default cache behavior for the distribution.StringdistributionName()The name of the distribution to update.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasCacheBehaviors()For responses, this returns true if the service returned a value for the CacheBehaviors property.inthashCode()BooleanisEnabled()Indicates whether to enable the distribution.InputOriginorigin()An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends UpdateDistributionRequest.Builder>serializableBuilderClass()UpdateDistributionRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.BooleanuseDefaultCertificate()Indicates whether the default SSL/TLS certificate is attached to the distribution.ViewerMinimumTlsProtocolVersionEnumviewerMinimumTlsProtocolVersion()Use this parameter to update the minimum TLS protocol version for the SSL/TLS certificate that's attached to the distribution.StringviewerMinimumTlsProtocolVersionAsString()Use this parameter to update the minimum TLS protocol version for the SSL/TLS certificate that's attached to the distribution.-
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
-
distributionName
public final String distributionName()
The name of the distribution to update.
Use the
GetDistributionsaction to get a list of distribution names that you can specify.- Returns:
- The name of the distribution to update.
Use the
GetDistributionsaction 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
cacheBehaviorSettingsspecified in yourUpdateDistributionRequestwill replace your distribution's existing settings.- Returns:
- An object that describes the cache behavior settings for the distribution.
The
cacheBehaviorSettingsspecified in yourUpdateDistributionRequestwill 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 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.
-
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,
viewerMinimumTlsProtocolVersionwill returnViewerMinimumTlsProtocolVersionEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromviewerMinimumTlsProtocolVersionAsString().- Returns:
- Use this parameter to update the minimum TLS protocol version for the SSL/TLS certificate that's attached to the distribution.
- See Also:
ViewerMinimumTlsProtocolVersionEnum
-
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,
viewerMinimumTlsProtocolVersionwill returnViewerMinimumTlsProtocolVersionEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromviewerMinimumTlsProtocolVersionAsString().- Returns:
- Use this parameter to update the minimum TLS protocol version for the SSL/TLS certificate that's attached to the distribution.
- See Also:
ViewerMinimumTlsProtocolVersionEnum
-
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
ISSUEDcan 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
ISSUEDcan 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. Whentrue, the distribution uses the default domain name such asd111111abcdef8.cloudfront.net.Set this value to
falseto 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. Whentrue, the distribution uses the default domain name such asd111111abcdef8.cloudfront.net.Set this value to
falseto attach a new certificate to the distribution.
-
toBuilder
public UpdateDistributionRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateDistributionRequest.Builder,UpdateDistributionRequest>- Specified by:
toBuilderin classLightsailRequest
-
builder
public static UpdateDistributionRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateDistributionRequest.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
-
-