Package software.amazon.awssdk.services.cloudfront.model

Interface InvalidationBatch.Builder

All Superinterfaces:

Buildable, CopyableBuilder<InvalidationBatch.Builder,InvalidationBatch>, SdkBuilder<InvalidationBatch.Builder,InvalidationBatch>, SdkPojo

Enclosing class:

InvalidationBatch

public static interface InvalidationBatch.Builder
extends SdkPojo, CopyableBuilder<InvalidationBatch.Builder,InvalidationBatch>

Method Summary

Modifier and Type	Method	Description
InvalidationBatch.Builder	callerReference(String callerReference)	A value that you specify to uniquely identify an invalidation request.
default InvalidationBatch.Builder	paths(Consumer<Paths.Builder> paths)	A complex type that contains information about the objects that you want to invalidate.
InvalidationBatch.Builder	paths(Paths paths)	A complex type that contains information about the objects that you want to invalidate.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

paths

InvalidationBatch.Builder paths(Paths paths)

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

Parameters:

paths - A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

paths

default InvalidationBatch.Builder paths(Consumer<Paths.Builder> paths)

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

This is a convenience method that creates an instance of the Paths.Builder avoiding the need to create one manually via Paths.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to paths(Paths).

Parameters:

paths - a consumer that will call methods on Paths.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

paths(Paths)

callerReference

InvalidationBatch.Builder callerReference(String callerReference)

A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for CallerReference and change other values in the request as applicable. One way to ensure that the value of CallerReference is unique is to use a timestamp, for example, 20120301090000.

If you make a second invalidation request with the same value for CallerReference, and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same CallerReference.

If CallerReference is a value you already sent in a previous invalidation batch request but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error.

Parameters:

callerReference - A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for CallerReference and change other values in the request as applicable. One way to ensure that the value of CallerReference is unique is to use a timestamp, for example, 20120301090000.

If you make a second invalidation request with the same value for CallerReference, and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same CallerReference.

If CallerReference is a value you already sent in a previous invalidation batch request but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error.

Returns:

Returns a reference to this object so that method calls can be chained together.