LightsailDistribution (AWS Java SDK :: Services :: Amazon Lightsail 2.18.21 API)

java.lang.Object
- software.amazon.awssdk.services.lightsail.model.LightsailDistribution

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<LightsailDistribution.Builder,LightsailDistribution>

@Generated(value="software.amazon.awssdk:codegen")
public final class LightsailDistribution
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LightsailDistribution.Builder,LightsailDistribution>

Describes an Amazon Lightsail content delivery network (CDN) distribution.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface LightsailDistribution.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`LightsailDistribution.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`ableToUpdateBundle()` Indicates whether the bundle that is currently applied to your distribution, specified using the `distributionName` parameter, can be changed to another bundle.
`List<String>`	`alternativeDomainNames()` The alternate domain names of the distribution.
`String`	`arn()` The Amazon Resource Name (ARN) of the distribution.
`static LightsailDistribution.Builder`	`builder()`
`String`	`bundleId()` The ID of the bundle currently applied to the distribution.
`List<CacheBehaviorPerPath>`	`cacheBehaviors()` An array of objects that describe the per-path cache behavior of the distribution.
`CacheSettings`	`cacheBehaviorSettings()` An object that describes the cache behavior settings of the distribution.
`String`	`certificateName()` The name of the SSL/TLS certificate attached to the distribution, if any.
`Instant`	`createdAt()` The timestamp when the distribution was created.
`CacheBehavior`	`defaultCacheBehavior()` An object that describes the default cache behavior of the distribution.
`String`	`domainName()` The domain name of the distribution.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAlternativeDomainNames()` For responses, this returns true if the service returned a value for the AlternativeDomainNames property.
`boolean`	`hasCacheBehaviors()` For responses, this returns true if the service returned a value for the CacheBehaviors property.
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`IpAddressType`	`ipAddressType()` The IP address type of the distribution.
`String`	`ipAddressTypeAsString()` The IP address type of the distribution.
`Boolean`	`isEnabled()` Indicates whether the distribution is enabled.
`ResourceLocation`	`location()` An object that describes the location of the distribution, such as the Amazon Web Services Region and Availability Zone.
`String`	`name()` The name of the distribution.
`Origin`	`origin()` An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.
`String`	`originPublicDNS()` The public DNS of the origin.
`ResourceType`	`resourceType()` The Lightsail resource type (e.g., `Distribution`).
`String`	`resourceTypeAsString()` The Lightsail resource type (e.g., `Distribution`).
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends LightsailDistribution.Builder>`	`serializableBuilderClass()`
`String`	`status()` The status of the distribution.
`String`	`supportCode()` The support code.
`List<Tag>`	`tags()` The tag keys and optional values for the resource.
`LightsailDistribution.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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
  - name
```
public final String name()
```
    The name of the distribution.
    
    Returns:
    
    The name of the distribution.
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the distribution.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the distribution.
  - supportCode
```
public final String supportCode()
```
    The support code. Include this code in your email to support when you have questions about your Lightsail distribution. This code enables our support team to look up your Lightsail information more easily.
    
    Returns:
    
    The support code. Include this code in your email to support when you have questions about your Lightsail distribution. This code enables our support team to look up your Lightsail information more easily.
  - createdAt
```
public final Instant createdAt()
```
    The timestamp when the distribution was created.
    
    Returns:
    
    The timestamp when the distribution was created.
  - location
```
public final ResourceLocation location()
```
    An object that describes the location of the distribution, such as the Amazon Web Services Region and Availability Zone.
    
    Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.
    
    Returns:
    
    An object that describes the location of the distribution, such as the Amazon Web Services Region and Availability Zone.
    
    Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.
  - resourceType
```
public final ResourceType resourceType()
```
    The Lightsail resource type (e.g., Distribution).
    
    If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().
    
    Returns:
    
    The Lightsail resource type (e.g., Distribution).
    
    See Also:
    
    ResourceType
  - resourceTypeAsString
```
public final String resourceTypeAsString()
```
    The Lightsail resource type (e.g., Distribution).
    
    If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().
    
    Returns:
    
    The Lightsail resource type (e.g., Distribution).
    
    See Also:
    
    ResourceType
  - hasAlternativeDomainNames
```
public final boolean hasAlternativeDomainNames()
```
    For responses, this returns true if the service returned a value for the AlternativeDomainNames 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.
  - alternativeDomainNames
```
public final List<String> alternativeDomainNames()
```
    The alternate domain names of 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 hasAlternativeDomainNames() method.
    
    Returns:
    
    The alternate domain names of the distribution.
  - status
```
public final String status()
```
    The status of the distribution.
    
    Returns:
    
    The status of the distribution.
  - isEnabled
```
public final Boolean isEnabled()
```
    Indicates whether the distribution is enabled.
    
    Returns:
    
    Indicates whether the distribution is enabled.
  - domainName
```
public final String domainName()
```
    The domain name of the distribution.
    
    Returns:
    
    The domain name of the distribution.
  - bundleId
```
public final String bundleId()
```
    The ID of the bundle currently applied to the distribution.
    
    Returns:
    
    The ID of the bundle currently applied to the distribution.
  - certificateName
```
public final String certificateName()
```
    The name of the SSL/TLS certificate attached to the distribution, if any.
    
    Returns:
    
    The name of the SSL/TLS certificate attached to the distribution, if any.
  - origin
```
public final Origin origin()
```
    An object that describes the origin resource of 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 of the distribution, such as a Lightsail instance, bucket, or load balancer.
    
    The distribution pulls, caches, and serves content from the origin.
  - originPublicDNS
```
public final String originPublicDNS()
```
    The public DNS of the origin.
    
    Returns:
    
    The public DNS of the origin.
  - defaultCacheBehavior
```
public final CacheBehavior defaultCacheBehavior()
```
    An object that describes the default cache behavior of the distribution.
    
    Returns:
    
    An object that describes the default cache behavior of the distribution.
  - cacheBehaviorSettings
```
public final CacheSettings cacheBehaviorSettings()
```
    An object that describes the cache behavior settings of the distribution.
    
    Returns:
    
    An object that describes the cache behavior settings of the distribution.
  - 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 of 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 of the distribution.
  - ableToUpdateBundle
```
public final Boolean ableToUpdateBundle()
```
    Indicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle.
    
    Use the UpdateDistributionBundle action to change your distribution's bundle.
    
    Returns:
    
    Indicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle.
    
    Use the UpdateDistributionBundle action to change your distribution's bundle.
  - ipAddressType
```
public final IpAddressType ipAddressType()
```
    The IP address type of the distribution.
    
    The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
    
    If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().
    
    Returns:
    
    The IP address type of the distribution.
    
    The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
    
    See Also:
    
    IpAddressType
  - ipAddressTypeAsString
```
public final String ipAddressTypeAsString()
```
    The IP address type of the distribution.
    
    The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
    
    If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().
    
    Returns:
    
    The IP address type of the distribution.
    
    The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
    
    See Also:
    
    IpAddressType
  - 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()
```
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
    
    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:
    
    The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
  - toBuilder
```
public LightsailDistribution.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<LightsailDistribution.Builder,LightsailDistribution>
  - builder
```
public static LightsailDistribution.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends LightsailDistribution.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class LightsailDistribution

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

arn

supportCode

createdAt

location

resourceType

resourceTypeAsString

hasAlternativeDomainNames

alternativeDomainNames

status

isEnabled

domainName

bundleId

certificateName

origin

originPublicDNS

defaultCacheBehavior

cacheBehaviorSettings

hasCacheBehaviors

cacheBehaviors

ableToUpdateBundle

ipAddressType

ipAddressTypeAsString

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields