Origin (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.cloudfront.model

Class Origin

java.lang.Object
- com.amazonaws.services.cloudfront.model.Origin

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Origin
extends Object
implements Serializable, Cloneable 
```
An origin.

An origin is the location where content is stored, and from which CloudFront gets content to serve to viewers. To specify an origin:
- Use S3OriginConfig to specify an Amazon S3 bucket that is not configured with static website hosting.
- Use CustomOriginConfig to specify all other kinds of origins, including:
  - An Amazon S3 bucket that is configured with static website hosting
  - An Elastic Load Balancing load balancer
  - An Elemental MediaPackage endpoint
  - An Elemental MediaStore container
  - Any other HTTP server, running on an Amazon EC2 instance or any other kind of host
For the current maximum number of origins that you can specify per distribution, see General Quotas on Web Distributions in the Amazon CloudFront Developer Guide (quotas were formerly referred to as limits).
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Origin ()

Constructors
Constructor and Description
`Origin ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`Origin`	`clone ()`
`boolean`	`equals (Object obj)`
`Integer`	`getConnectionAttempts ()` The number of times that CloudFront attempts to connect to the origin.
`Integer`	`getConnectionTimeout ()` The number of seconds that CloudFront waits when trying to establish a connection to the origin.
`CustomHeaders`	`getCustomHeaders ()` A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
`CustomOriginConfig`	`getCustomOriginConfig ()` Use this type to specify an origin that is not an Amazon S3 bucket, with one exception.
`String`	`getDomainName ()` The domain name for the origin.
`String`	`getId ()` A unique identifier for the origin.
`String`	`getOriginAccessControlId ()` The unique identifier of an origin access control for this origin.
`String`	`getOriginPath ()` An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
`OriginShield`	`getOriginShield ()` CloudFront Origin Shield.
`S3OriginConfig`	`getS3OriginConfig ()` Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting.
`int`	`hashCode ()`
`void`	`setConnectionAttempts (Integer connectionAttempts)` The number of times that CloudFront attempts to connect to the origin.
`void`	`setConnectionTimeout (Integer connectionTimeout)` The number of seconds that CloudFront waits when trying to establish a connection to the origin.
`void`	`setCustomHeaders (CustomHeaders customHeaders)` A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
`void`	`setCustomOriginConfig (CustomOriginConfig customOriginConfig)` Use this type to specify an origin that is not an Amazon S3 bucket, with one exception.
`void`	`setDomainName (String domainName)` The domain name for the origin.
`void`	`setId (String id)` A unique identifier for the origin.
`void`	`setOriginAccessControlId (String originAccessControlId)` The unique identifier of an origin access control for this origin.
`void`	`setOriginPath (String originPath)` An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
`void`	`setOriginShield (OriginShield originShield)` CloudFront Origin Shield.
`void`	`setS3OriginConfig (S3OriginConfig s3OriginConfig)` Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting.
`String`	`toString ()` Returns a string representation of this object.
`Origin`	`withConnectionAttempts (Integer connectionAttempts)` The number of times that CloudFront attempts to connect to the origin.
`Origin`	`withConnectionTimeout (Integer connectionTimeout)` The number of seconds that CloudFront waits when trying to establish a connection to the origin.
`Origin`	`withCustomHeaders (CustomHeaders customHeaders)` A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
`Origin`	`withCustomOriginConfig (CustomOriginConfig customOriginConfig)` Use this type to specify an origin that is not an Amazon S3 bucket, with one exception.
`Origin`	`withDomainName (String domainName)` The domain name for the origin.
`Origin`	`withId (String id)` A unique identifier for the origin.
`Origin`	`withOriginAccessControlId (String originAccessControlId)` The unique identifier of an origin access control for this origin.
`Origin`	`withOriginPath (String originPath)` An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
`Origin`	`withOriginShield (OriginShield originShield)` CloudFront Origin Shield.
`Origin`	`withS3OriginConfig (S3OriginConfig s3OriginConfig)` Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Origin
```
public Origin()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    A unique identifier for the origin. This value must be unique within the distribution.
    
    Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior.
    
    Parameters:
    
    id - A unique identifier for the origin. This value must be unique within the distribution.
    
    Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior.
  - getId
```
public String getId()
```
    A unique identifier for the origin. This value must be unique within the distribution.
    
    Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior.
    
    Returns:
    
    A unique identifier for the origin. This value must be unique within the distribution.
    
    Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior.
  - withId
```
public Origin withId(String id)
```
    A unique identifier for the origin. This value must be unique within the distribution.
    
    Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior.
    
    Parameters:
    
    id - A unique identifier for the origin. This value must be unique within the distribution.
    
    Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDomainName
```
public void setDomainName(String domainName)
```
    The domain name for the origin.
    
    For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.
    
    Parameters:
    
    domainName - The domain name for the origin.
    
    For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.
  - getDomainName
```
public String getDomainName()
```
    The domain name for the origin.
    
    For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.
    
    Returns:
    
    The domain name for the origin.
    
    For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.
  - withDomainName
```
public Origin withDomainName(String domainName)
```
    The domain name for the origin.
    
    For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.
    
    Parameters:
    
    domainName - The domain name for the origin.
    
    For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOriginPath
```
public void setOriginPath(String originPath)
```
    An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
    
    For more information, see Origin Path in the Amazon CloudFront Developer Guide.
    
    Parameters:
    
    originPath - An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
    
    For more information, see Origin Path in the Amazon CloudFront Developer Guide.
  - getOriginPath
```
public String getOriginPath()
```
    An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
    
    For more information, see Origin Path in the Amazon CloudFront Developer Guide.
    
    Returns:
    
    An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
    
    For more information, see Origin Path in the Amazon CloudFront Developer Guide.
  - withOriginPath
```
public Origin withOriginPath(String originPath)
```
    An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
    
    For more information, see Origin Path in the Amazon CloudFront Developer Guide.
    
    Parameters:
    
    originPath - An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.
    
    For more information, see Origin Path in the Amazon CloudFront Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustomHeaders
```
public void setCustomHeaders(CustomHeaders customHeaders)
```
    A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
    
    For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
    
    Parameters:
    
    customHeaders - A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
    
    For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
  - getCustomHeaders
```
public CustomHeaders getCustomHeaders()
```
    A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
    
    For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
    
    Returns:
    
    A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
    
    For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
  - withCustomHeaders
```
public Origin withCustomHeaders(CustomHeaders customHeaders)
```
    A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
    
    For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
    
    Parameters:
    
    customHeaders - A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.
    
    For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3OriginConfig
```
public void setS3OriginConfig(S3OriginConfig s3OriginConfig)
```
    Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.
    
    Parameters:
    
    s3OriginConfig - Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.
  - getS3OriginConfig
```
public S3OriginConfig getS3OriginConfig()
```
    Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.
    
    Returns:
    
    Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.
  - withS3OriginConfig
```
public Origin withS3OriginConfig(S3OriginConfig s3OriginConfig)
```
    Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.
    
    Parameters:
    
    s3OriginConfig - Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustomOriginConfig
```
public void setCustomOriginConfig(CustomOriginConfig customOriginConfig)
```
    Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
    
    Parameters:
    
    customOriginConfig - Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
  - getCustomOriginConfig
```
public CustomOriginConfig getCustomOriginConfig()
```
    Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
    
    Returns:
    
    Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
  - withCustomOriginConfig
```
public Origin withCustomOriginConfig(CustomOriginConfig customOriginConfig)
```
    Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
    
    Parameters:
    
    customOriginConfig - Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConnectionAttempts
```
public void setConnectionAttempts(Integer connectionAttempts)
```
    The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3.
    
    For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout.
    
    For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.
    
    Parameters:
    
    connectionAttempts - The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3.
    
    For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout.
    
    For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.
  - getConnectionAttempts
```
public Integer getConnectionAttempts()
```
    The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3.
    
    For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout.
    
    For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.
    
    Returns:
    
    The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3.
    
    For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout.
    
    For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.
  - withConnectionAttempts
```
public Origin withConnectionAttempts(Integer connectionAttempts)
```
    The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3.
    
    For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout.
    
    For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.
    
    Parameters:
    
    connectionAttempts - The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3.
    
    For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout.
    
    For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConnectionTimeout
```
public void setConnectionTimeout(Integer connectionTimeout)
```
    The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds.
    
    For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.
    
    Parameters:
    
    connectionTimeout - The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds.
    
    For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.
  - getConnectionTimeout
```
public Integer getConnectionTimeout()
```
    The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds.
    
    For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.
    
    Returns:
    
    The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds.
    
    For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.
  - withConnectionTimeout
```
public Origin withConnectionTimeout(Integer connectionTimeout)
```
    The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds.
    
    For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.
    
    Parameters:
    
    connectionTimeout - The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds.
    
    For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOriginShield
```
public void setOriginShield(OriginShield originShield)
```
    CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.
    
    For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
    
    Parameters:
    
    originShield - CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.
    
    For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
  - getOriginShield
```
public OriginShield getOriginShield()
```
    CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.
    
    For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
    
    Returns:
    
    CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.
    
    For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
  - withOriginShield
```
public Origin withOriginShield(OriginShield originShield)
```
    CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.
    
    For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
    
    Parameters:
    
    originShield - CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.
    
    For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOriginAccessControlId
```
public void setOriginAccessControlId(String originAccessControlId)
```
    The unique identifier of an origin access control for this origin.
    
    For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide.
    
    Parameters:
    
    originAccessControlId - The unique identifier of an origin access control for this origin.
    
    For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide.
  - getOriginAccessControlId
```
public String getOriginAccessControlId()
```
    The unique identifier of an origin access control for this origin.
    
    For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide.
    
    Returns:
    
    The unique identifier of an origin access control for this origin.
    
    For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide.
  - withOriginAccessControlId
```
public Origin withOriginAccessControlId(String originAccessControlId)
```
    The unique identifier of an origin access control for this origin.
    
    For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide.
    
    Parameters:
    
    originAccessControlId - The unique identifier of an origin access control for this origin.
    
    For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Origin clone()
```
    Overrides:
    
    clone in class Object

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class Origin

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Origin

Method Detail

setId

getId

withId

setDomainName

getDomainName

withDomainName

setOriginPath

getOriginPath

withOriginPath

setCustomHeaders

getCustomHeaders

withCustomHeaders

setS3OriginConfig

getS3OriginConfig

withS3OriginConfig

setCustomOriginConfig

getCustomOriginConfig

withCustomOriginConfig

setConnectionAttempts

getConnectionAttempts

withConnectionAttempts

setConnectionTimeout

getConnectionTimeout

withConnectionTimeout

setOriginShield

getOriginShield

withOriginShield

setOriginAccessControlId

getOriginAccessControlId

withOriginAccessControlId

toString

equals

hashCode

clone