Class LightsailDistribution
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<LightsailDistribution.Builder,
LightsailDistribution>
Describes an Amazon Lightsail content delivery network (CDN) distribution.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Indicates whether the bundle that is currently applied to your distribution, specified using thedistributionName
parameter, can be changed to another bundle.The alternate domain names of the distribution.final String
arn()
The Amazon Resource Name (ARN) of the distribution.builder()
final String
bundleId()
The ID of the bundle currently applied to the distribution.final List
<CacheBehaviorPerPath> An array of objects that describe the per-path cache behavior of the distribution.final CacheSettings
An object that describes the cache behavior settings of the distribution.final String
The name of the SSL/TLS certificate attached to the distribution, if any.final Instant
The timestamp when the distribution was created.final CacheBehavior
An object that describes the default cache behavior of the distribution.final String
The domain name of the distribution.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) final boolean
For responses, this returns true if the service returned a value for the AlternativeDomainNames property.final boolean
For responses, this returns true if the service returned a value for the CacheBehaviors property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final IpAddressType
The IP address type of the distribution.final String
The IP address type of the distribution.final Boolean
Indicates whether the distribution is enabled.final ResourceLocation
location()
An object that describes the location of the distribution, such as the Amazon Web Services Region and Availability Zone.final String
name()
The name of the distribution.final Origin
origin()
An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.final String
The public DNS of the origin.final ResourceType
The Lightsail resource type (Distribution
).final String
The Lightsail resource type (Distribution
).static Class
<? extends LightsailDistribution.Builder> final String
status()
The status of the distribution.final String
The support code.tags()
The tag keys and optional values for the 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.final String
The minimum TLS protocol version that the distribution can use to communicate with viewers.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the distribution.
- Returns:
- The name of the distribution.
-
arn
The Amazon Resource Name (ARN) of the distribution.
- Returns:
- The Amazon Resource Name (ARN) of the distribution.
-
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
The timestamp when the distribution was created.
- Returns:
- The timestamp when the distribution was created.
-
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
The Lightsail resource type (
Distribution
).If the service returns an enum value that is not available in the current SDK version,
resourceType
will returnResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- The Lightsail resource type (
Distribution
). - See Also:
-
resourceTypeAsString
The Lightsail resource type (
Distribution
).If the service returns an enum value that is not available in the current SDK version,
resourceType
will returnResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- The Lightsail resource type (
Distribution
). - See Also:
-
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 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. -
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
The status of the distribution.
- Returns:
- The status of the distribution.
-
isEnabled
Indicates whether the distribution is enabled.
- Returns:
- Indicates whether the distribution is enabled.
-
domainName
The domain name of the distribution.
- Returns:
- The domain name of the distribution.
-
bundleId
The ID of the bundle currently applied to the distribution.
- Returns:
- The ID of the bundle currently applied to the distribution.
-
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
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
The public DNS of the origin.
- Returns:
- The public DNS of the origin.
-
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
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 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
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
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
The IP address type of the distribution.
The possible values are
ipv4
for IPv4 only, anddualstack
for IPv4 and IPv6.If the service returns an enum value that is not available in the current SDK version,
ipAddressType
will returnIpAddressType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromipAddressTypeAsString()
.- Returns:
- The IP address type of the distribution.
The possible values are
ipv4
for IPv4 only, anddualstack
for IPv4 and IPv6. - See Also:
-
ipAddressTypeAsString
The IP address type of the distribution.
The possible values are
ipv4
for IPv4 only, anddualstack
for IPv4 and IPv6.If the service returns an enum value that is not available in the current SDK version,
ipAddressType
will returnIpAddressType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromipAddressTypeAsString()
.- Returns:
- The IP address type of the distribution.
The possible values are
ipv4
for IPv4 only, anddualstack
for IPv4 and IPv6. - See Also:
-
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
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.
-
viewerMinimumTlsProtocolVersion
The minimum TLS protocol version that the distribution can use to communicate with viewers.
- Returns:
- The minimum TLS protocol version that the distribution can use to communicate with viewers.
-
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<LightsailDistribution.Builder,
LightsailDistribution> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-