public static interface Origin.Builder extends CopyableBuilder<Origin.Builder,Origin>
Modifier and Type | Method and Description |
---|---|
default Origin.Builder |
customHeaders(Consumer<CustomHeaders.Builder> customHeaders)
A complex type that contains names and values for the custom headers that you want.
|
Origin.Builder |
customHeaders(CustomHeaders customHeaders)
A complex type that contains names and values for the custom headers that you want.
|
default Origin.Builder |
customOriginConfig(Consumer<CustomOriginConfig.Builder> customOriginConfig)
A complex type that contains information about a custom origin.
|
Origin.Builder |
customOriginConfig(CustomOriginConfig customOriginConfig)
A complex type that contains information about a custom origin.
|
Origin.Builder |
domainName(String domainName)
Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects
for this origin, for example,
myawsbucket.s3.amazonaws.com . |
Origin.Builder |
id(String id)
A unique identifier for the origin.
|
Origin.Builder |
originPath(String originPath)
An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket
or your custom origin.
|
default Origin.Builder |
s3OriginConfig(Consumer<S3OriginConfig.Builder> s3OriginConfig)
A complex type that contains information about the Amazon S3 origin.
|
Origin.Builder |
s3OriginConfig(S3OriginConfig s3OriginConfig)
A complex type that contains information about the Amazon S3 origin.
|
copy
applyMutation, build
Origin.Builder id(String id)
A unique identifier for the origin. The value of Id
must be unique within the distribution.
When you specify the value of TargetOriginId
for the default cache behavior or for another cache
behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the
value of the Id
element for that origin. When a request matches the path pattern for that cache
behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.
id
- A unique identifier for the origin. The value of Id
must be unique within the
distribution.
When you specify the value of TargetOriginId
for the default cache behavior or for
another cache behavior, you indicate the origin to which you want the cache behavior to route requests
by specifying the value of the Id
element for that origin. When a request matches the
path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more
information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.
Origin.Builder domainName(String domainName)
Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects
for this origin, for example, myawsbucket.s3.amazonaws.com
.
Constraints for Amazon S3 origins:
If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the
s3-accelerate
endpoint for DomainName
.
The bucket name must be between 3 and 63 characters long (inclusive).
The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.
The bucket name must not contain adjacent periods.
Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects
for this origin, for example, www.example.com
.
Constraints for custom origins:
DomainName
must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or
underscore (_) characters.
The name cannot exceed 128 characters.
domainName
- Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get
objects for this origin, for example, myawsbucket.s3.amazonaws.com
.
Constraints for Amazon S3 origins:
If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the
s3-accelerate
endpoint for DomainName
.
The bucket name must be between 3 and 63 characters long (inclusive).
The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.
The bucket name must not contain adjacent periods.
Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get
objects for this origin, for example, www.example.com
.
Constraints for custom origins:
DomainName
must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen
(-), or underscore (_) characters.
The name cannot exceed 128 characters.
Origin.Builder originPath(String originPath)
An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket
or your custom origin. When you include the OriginPath
element, specify the directory name,
beginning with a /
. CloudFront appends the directory name to the value of
DomainName
, for example, example.com/production
. Do not include a /
at
the end of the directory name.
For example, suppose you've specified the following values for your distribution:
DomainName
: An Amazon S3 bucket named myawsbucket
.
OriginPath
: /production
CNAME
: example.com
When a user enters example.com/index.html
in a browser, CloudFront sends a request to Amazon S3
for myawsbucket/production/index.html
.
When a user enters example.com/acme/index.html
in a browser, CloudFront sends a request to
Amazon S3 for myawsbucket/production/acme/index.html
.
originPath
- An optional element that causes CloudFront to request your content from a directory in your Amazon S3
bucket or your custom origin. When you include the OriginPath
element, specify the
directory name, beginning with a /
. CloudFront appends the directory name to the value of
DomainName
, for example, example.com/production
. Do not include a
/
at the end of the directory name.
For example, suppose you've specified the following values for your distribution:
DomainName
: An Amazon S3 bucket named myawsbucket
.
OriginPath
: /production
CNAME
: example.com
When a user enters example.com/index.html
in a browser, CloudFront sends a request to
Amazon S3 for myawsbucket/production/index.html
.
When a user enters example.com/acme/index.html
in a browser, CloudFront sends a request
to Amazon S3 for myawsbucket/production/acme/index.html
.
Origin.Builder customHeaders(CustomHeaders customHeaders)
A complex type that contains names and values for the custom headers that you want.
customHeaders
- A complex type that contains names and values for the custom headers that you want.default Origin.Builder customHeaders(Consumer<CustomHeaders.Builder> customHeaders)
A complex type that contains names and values for the custom headers that you want.
This is a convenience that creates an instance of theCustomHeaders.Builder
avoiding the need to
create one manually via CustomHeaders.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to customHeaders(CustomHeaders)
.customHeaders
- a consumer that will call methods on CustomHeaders.Builder
customHeaders(CustomHeaders)
Origin.Builder s3OriginConfig(S3OriginConfig s3OriginConfig)
A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use
the CustomOriginConfig
element instead.
s3OriginConfig
- A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin,
use the CustomOriginConfig
element instead.default Origin.Builder s3OriginConfig(Consumer<S3OriginConfig.Builder> s3OriginConfig)
A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use
the CustomOriginConfig
element instead.
S3OriginConfig.Builder
avoiding the need to
create one manually via S3OriginConfig.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to s3OriginConfig(S3OriginConfig)
.s3OriginConfig
- a consumer that will call methods on S3OriginConfig.Builder
s3OriginConfig(S3OriginConfig)
Origin.Builder customOriginConfig(CustomOriginConfig customOriginConfig)
A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the
S3OriginConfig
element instead.
customOriginConfig
- A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket,
use the S3OriginConfig
element instead.default Origin.Builder customOriginConfig(Consumer<CustomOriginConfig.Builder> customOriginConfig)
A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the
S3OriginConfig
element instead.
CustomOriginConfig.Builder
avoiding the need to
create one manually via CustomOriginConfig.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to customOriginConfig(CustomOriginConfig)
.customOriginConfig
- a consumer that will call methods on CustomOriginConfig.Builder
customOriginConfig(CustomOriginConfig)
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.