@Generated(value="software.amazon.awssdk:codegen") public class Origin extends Object implements ToCopyableBuilder<Origin.Builder,Origin>
A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files. You must create at least one origin.
For the current limit on the number of origins that you can create for a distribution, see Amazon CloudFront Limits in the AWS General Reference.
Modifier and Type | Class and Description |
---|---|
static interface |
Origin.Builder |
Modifier and Type | Method and Description |
---|---|
static Origin.Builder |
builder() |
CustomHeaders |
customHeaders()
A complex type that contains names and values for the custom headers that you want.
|
CustomOriginConfig |
customOriginConfig()
A complex type that contains information about a custom origin.
|
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 . |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
id()
A unique identifier for the origin.
|
String |
originPath()
An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or
your custom origin.
|
S3OriginConfig |
s3OriginConfig()
A complex type that contains information about the Amazon S3 origin.
|
static Class<? extends Origin.Builder> |
serializableBuilderClass() |
Origin.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public 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
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.
public 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.
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.
public 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
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
.
public CustomHeaders customHeaders()
A complex type that contains names and values for the custom headers that you want.
public 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.
CustomOriginConfig
element instead.public 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.
S3OriginConfig
element instead.public Origin.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Origin.Builder,Origin>
public static Origin.Builder builder()
public static Class<? extends Origin.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.