software.amazon.awssdk.services.cloudfront.model

Class Distribution

java.lang.Object

software.amazon.awssdk.services.cloudfront.model.Distribution

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Distribution.Builder,Distribution>

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

A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Distribution.Builder

Method Summary

Modifier and Type	Method and Description
ActiveTrustedKeyGroups	activeTrustedKeyGroups() CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using key groups.
ActiveTrustedSigners	activeTrustedSigners()
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 Distribution.Builder	builder()
DistributionConfig	distributionConfig() The current configuration information for the distribution.
String	domainName() The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.
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()
String	id() The identifier for the distribution.
Integer	inProgressInvalidationBatches() The number of invalidation batches currently in progress.
Instant	lastModifiedTime() The date and time the distribution was last modified.
List<SdkField<?>>	sdkFields()
static Class<? extends Distribution.Builder>	serializableBuilderClass()
String	status() This response element indicates the current status of the distribution.
Distribution.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

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, where 123456789012 is your account ID.

Returns:

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your account ID.

status

public final String status()

This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated to all CloudFront edge locations.

Returns:

This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully 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.

inProgressInvalidationBatches

public final Integer inProgressInvalidationBatches()

The number of invalidation batches currently in progress.

Returns:

The number of invalidation batches currently in progress.

domainName

public final String domainName()

The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

Returns:

The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

activeTrustedSigners

public final ActiveTrustedSigners activeTrustedSigners()

We recommend using TrustedKeyGroups instead of TrustedSigners.

CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using trusted signers. This field contains a list of account IDs and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs or signed cookies.

Returns:

We recommend using TrustedKeyGroups instead of TrustedSigners.

CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using trusted signers. This field contains a list of account IDs and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs or signed cookies.

activeTrustedKeyGroups

public final ActiveTrustedKeyGroups activeTrustedKeyGroups()

CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using key groups. This field contains a list of key groups and the public keys in each key group that CloudFront can use to verify the signatures of signed URLs or signed cookies.

Returns:

CloudFront automatically adds this field to the response if you’ve configured a cache behavior in this distribution to serve private content using key groups. This field contains a list of key groups and the public keys in each key group that CloudFront can use to verify the signatures of signed URLs or signed cookies.

distributionConfig

public final DistributionConfig distributionConfig()

The current configuration information for the distribution. Send a GET request to the /CloudFront API version/distribution ID/config resource.

Returns:

The current configuration information for the distribution. Send a GET request to the /CloudFront API version/distribution ID/config resource.

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 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.

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.

toBuilder

public Distribution.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Distribution.Builder,Distribution>

builder

public static Distribution.Builder builder()

serializableBuilderClass

public static Class<? extends Distribution.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