Class DistributionSummary
- java.lang.Object
-
- software.amazon.awssdk.services.cloudfront.model.DistributionSummary
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DistributionSummary.Builder,DistributionSummary>
@Generated("software.amazon.awssdk:codegen") public final class DistributionSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DistributionSummary.Builder,DistributionSummary>
A summary of the information about a CloudFront distribution.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DistributionSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Aliases
aliases()
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.List<AliasICPRecordal>
aliasICPRecordals()
Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront.String
arn()
The ARN (Amazon Resource Name) for the distribution.static DistributionSummary.Builder
builder()
CacheBehaviors
cacheBehaviors()
A complex type that contains zero or moreCacheBehavior
elements.String
comment()
The comment originally specified when this distribution was created.CustomErrorResponses
customErrorResponses()
A complex type that contains zero or moreCustomErrorResponses
elements.DefaultCacheBehavior
defaultCacheBehavior()
A complex type that describes the default cache behavior if you don't specify aCacheBehavior
element or if files don't match any of the values ofPathPattern
inCacheBehavior
elements.String
domainName()
The domain name that corresponds to the distribution, for example,d111111abcdef8.cloudfront.net
.Boolean
enabled()
Whether the distribution is enabled to accept user requests for content.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasAliasICPRecordals()
For responses, this returns true if the service returned a value for the AliasICPRecordals property.int
hashCode()
HttpVersion
httpVersion()
Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront.String
httpVersionAsString()
Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront.String
id()
The identifier for the distribution.Boolean
isIPV6Enabled()
Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.Instant
lastModifiedTime()
The date and time the distribution was last modified.OriginGroups
originGroups()
A complex type that contains information about origin groups for this distribution.Origins
origins()
A complex type that contains information about origins for this distribution.PriceClass
priceClass()
A complex type that contains information about price class for this streaming distribution.String
priceClassAsString()
A complex type that contains information about price class for this streaming distribution.Restrictions
restrictions()
A complex type that identifies ways in which you want to restrict distribution of your content.List<SdkField<?>>
sdkFields()
static Class<? extends DistributionSummary.Builder>
serializableBuilderClass()
Boolean
staging()
Whether the primary distribution has a staging distribution enabled.String
status()
The current status of the distribution.DistributionSummary.Builder
toBuilder()
String
toString()
Returns a string representation of this object.ViewerCertificate
viewerCertificate()
A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.String
webACLId()
The Web ACL Id (if any) associated with the distribution.-
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
-
id
public final String id()
The identifier for the distribution. For example:
EDFDVBD632BHDS5
.- Returns:
- The identifier for the distribution. For example:
EDFDVBD632BHDS5
.
-
arn
public final String arn()
The ARN (Amazon Resource Name) for the distribution. For example:
arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5
, where123456789012
is your Amazon Web Services account ID.- Returns:
- The ARN (Amazon Resource Name) for the distribution. For example:
arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5
, where123456789012
is your Amazon Web Services account ID.
-
status
public final String status()
The current status of the distribution. When the status is
Deployed
, the distribution's information is propagated to all CloudFront edge locations.- Returns:
- The current status of the distribution. When the status is
Deployed
, the distribution's information is propagated to all CloudFront edge locations.
-
lastModifiedTime
public final Instant lastModifiedTime()
The date and time the distribution was last modified.
- Returns:
- The date and time the distribution was last modified.
-
domainName
public final String domainName()
The domain name that corresponds to the distribution, for example,
d111111abcdef8.cloudfront.net
.- Returns:
- The domain name that corresponds to the distribution, for example,
d111111abcdef8.cloudfront.net
.
-
aliases
public final Aliases aliases()
A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
- Returns:
- A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
-
origins
public final Origins origins()
A complex type that contains information about origins for this distribution.
- Returns:
- A complex type that contains information about origins for this distribution.
-
originGroups
public final OriginGroups originGroups()
A complex type that contains information about origin groups for this distribution.
- Returns:
- A complex type that contains information about origin groups for this distribution.
-
defaultCacheBehavior
public final DefaultCacheBehavior defaultCacheBehavior()
A complex type that describes the default cache behavior if you don't specify a
CacheBehavior
element or if files don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior.- Returns:
- A complex type that describes the default cache behavior if you don't specify a
CacheBehavior
element or if files don't match any of the values ofPathPattern
inCacheBehavior
elements. You must create exactly one default cache behavior.
-
cacheBehaviors
public final CacheBehaviors cacheBehaviors()
A complex type that contains zero or more
CacheBehavior
elements.- Returns:
- A complex type that contains zero or more
CacheBehavior
elements.
-
customErrorResponses
public final CustomErrorResponses customErrorResponses()
A complex type that contains zero or more
CustomErrorResponses
elements.- Returns:
- A complex type that contains zero or more
CustomErrorResponses
elements.
-
comment
public final String comment()
The comment originally specified when this distribution was created.
- Returns:
- The comment originally specified when this distribution was created.
-
priceClass
public final PriceClass priceClass()
A complex type that contains information about price class for this streaming distribution.
If the service returns an enum value that is not available in the current SDK version,
priceClass
will returnPriceClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompriceClassAsString()
.- Returns:
- A complex type that contains information about price class for this streaming distribution.
- See Also:
PriceClass
-
priceClassAsString
public final String priceClassAsString()
A complex type that contains information about price class for this streaming distribution.
If the service returns an enum value that is not available in the current SDK version,
priceClass
will returnPriceClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompriceClassAsString()
.- Returns:
- A complex type that contains information about price class for this streaming distribution.
- See Also:
PriceClass
-
enabled
public final Boolean enabled()
Whether the distribution is enabled to accept user requests for content.
- Returns:
- Whether the distribution is enabled to accept user requests for content.
-
viewerCertificate
public final ViewerCertificate viewerCertificate()
A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.
- Returns:
- A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.
-
restrictions
public final Restrictions restrictions()
A complex type that identifies ways in which you want to restrict distribution of your content.
- Returns:
- A complex type that identifies ways in which you want to restrict distribution of your content.
-
webACLId
public final String webACLId()
The Web ACL Id (if any) associated with the distribution.
- Returns:
- The Web ACL Id (if any) associated with the distribution.
-
httpVersion
public final HttpVersion httpVersion()
Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is
http2
. Viewers that don't supportHTTP/2
will automatically use an earlier version.If the service returns an enum value that is not available in the current SDK version,
httpVersion
will returnHttpVersion.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpVersionAsString()
.- Returns:
- Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default
value for new web distributions is
http2
. Viewers that don't supportHTTP/2
will automatically use an earlier version. - See Also:
HttpVersion
-
httpVersionAsString
public final String httpVersionAsString()
Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is
http2
. Viewers that don't supportHTTP/2
will automatically use an earlier version.If the service returns an enum value that is not available in the current SDK version,
httpVersion
will returnHttpVersion.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhttpVersionAsString()
.- Returns:
- Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default
value for new web distributions is
http2
. Viewers that don't supportHTTP/2
will automatically use an earlier version. - See Also:
HttpVersion
-
isIPV6Enabled
public final Boolean isIPV6Enabled()
Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.
- Returns:
- Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.
-
hasAliasICPRecordals
public final boolean hasAliasICPRecordals()
For responses, this returns true if the service returned a value for the AliasICPRecordals 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.
-
aliasICPRecordals
public final List<AliasICPRecordal> aliasICPRecordals()
Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.
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
hasAliasICPRecordals()
method.- Returns:
- Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal
if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've
added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with
distributions.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.
-
staging
public final Boolean staging()
Whether the primary distribution has a staging distribution enabled.
- Returns:
- Whether the primary distribution has a staging distribution enabled.
-
toBuilder
public DistributionSummary.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DistributionSummary.Builder,DistributionSummary>
-
builder
public static DistributionSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends DistributionSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in 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.
-
-