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 interfaceDistributionSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Aliasesaliases()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.StringanycastIpListId()ID of the Anycast static IP list that is associated with the distribution.Stringarn()The ARN (Amazon Resource Name) for the distribution.static DistributionSummary.Builderbuilder()CacheBehaviorscacheBehaviors()A complex type that contains zero or moreCacheBehaviorelements.Stringcomment()The comment originally specified when this distribution was created.ConnectionModeconnectionMode()This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only).StringconnectionModeAsString()This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only).CustomErrorResponsescustomErrorResponses()A complex type that contains zero or moreCustomErrorResponseselements.DefaultCacheBehaviordefaultCacheBehavior()A complex type that describes the default cache behavior if you don't specify aCacheBehaviorelement or if files don't match any of the values ofPathPatterninCacheBehaviorelements.StringdomainName()The domain name that corresponds to the distribution, for example,d111111abcdef8.cloudfront.net.Booleanenabled()Whether the distribution is enabled to accept user requests for content.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringeTag()The current version of the distribution.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAliasICPRecordals()For responses, this returns true if the service returned a value for the AliasICPRecordals property.inthashCode()HttpVersionhttpVersion()Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront.StringhttpVersionAsString()Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront.Stringid()The identifier for the distribution.BooleanisIPV6Enabled()Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.InstantlastModifiedTime()The date and time the distribution was last modified.OriginGroupsoriginGroups()A complex type that contains information about origin groups for this distribution.Originsorigins()A complex type that contains information about origins for this distribution.PriceClasspriceClass()StringpriceClassAsString()Restrictionsrestrictions()A complex type that identifies ways in which you want to restrict distribution of your content.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends DistributionSummary.Builder>serializableBuilderClass()Booleanstaging()A Boolean that indicates whether this is a staging distribution.Stringstatus()The current status of the distribution.DistributionSummary.BuildertoBuilder()StringtoString()Returns a string representation of this object.ViewerCertificateviewerCertificate()A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.StringwebACLId()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, where123456789012is your Amazon Web Services account ID.- Returns:
- The ARN (Amazon Resource Name) for the distribution. For example:
arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where123456789012is your Amazon Web Services account ID.
-
eTag
public final String eTag()
The current version of the distribution.
- Returns:
- The current version of the distribution.
-
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
CacheBehaviorelement or if files don't match any of the values ofPathPatterninCacheBehaviorelements. You must create exactly one default cache behavior.- Returns:
- A complex type that describes the default cache behavior if you don't specify a
CacheBehaviorelement or if files don't match any of the values ofPathPatterninCacheBehaviorelements. You must create exactly one default cache behavior.
-
cacheBehaviors
public final CacheBehaviors cacheBehaviors()
A complex type that contains zero or more
CacheBehaviorelements.- Returns:
- A complex type that contains zero or more
CacheBehaviorelements.
-
customErrorResponses
public final CustomErrorResponses customErrorResponses()
A complex type that contains zero or more
CustomErrorResponseselements.- Returns:
- A complex type that contains zero or more
CustomErrorResponseselements.
-
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()
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
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,
priceClasswill returnPriceClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompriceClassAsString().- Returns:
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
A complex type that contains information about price class for this streaming distribution.
- See Also:
PriceClass
-
priceClassAsString
public final String priceClassAsString()
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
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,
priceClasswill returnPriceClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompriceClassAsString().- Returns:
This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.
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/2will automatically use an earlier version.If the service returns an enum value that is not available in the current SDK version,
httpVersionwill 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/2will 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/2will automatically use an earlier version.If the service returns an enum value that is not available in the current SDK version,
httpVersionwill 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/2will 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()
A Boolean that indicates whether this is a staging distribution. When this value is
true, this is a staging distribution. When this value isfalse, this is not a staging distribution.- Returns:
- A Boolean that indicates whether this is a staging distribution. When this value is
true, this is a staging distribution. When this value isfalse, this is not a staging distribution.
-
connectionMode
public final ConnectionMode connectionMode()
This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only).
If the service returns an enum value that is not available in the current SDK version,
connectionModewill returnConnectionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromconnectionModeAsString().- Returns:
- This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only).
- See Also:
ConnectionMode
-
connectionModeAsString
public final String connectionModeAsString()
This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only).
If the service returns an enum value that is not available in the current SDK version,
connectionModewill returnConnectionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromconnectionModeAsString().- Returns:
- This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only).
- See Also:
ConnectionMode
-
anycastIpListId
public final String anycastIpListId()
ID of the Anycast static IP list that is associated with the distribution.
- Returns:
- ID of the Anycast static IP list that is associated with the distribution.
-
toBuilder
public DistributionSummary.Builder toBuilder()
- Specified by:
toBuilderin 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:
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-