/AWS1/CL_FNTORIGIN

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 VpcOriginConfig to specify a VPC origin.

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

CONSTRUCTOR

IMPORTING

Required arguments:

iv_id TYPE /AWS1/FNTSTRING /AWS1/FNTSTRING

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.

iv_domainname TYPE /AWS1/FNTSTRING /AWS1/FNTSTRING

The domain name for the origin.

For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.

Optional arguments:

iv_originpath TYPE /AWS1/FNTSTRING /AWS1/FNTSTRING

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.

io_customheaders TYPE REF TO /AWS1/CL_FNTCUSTOMHEADERS /AWS1/CL_FNTCUSTOMHEADERS

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.

io_s3originconfig TYPE REF TO /AWS1/CL_FNTS3ORIGINCONFIG /AWS1/CL_FNTS3ORIGINCONFIG

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.

io_customoriginconfig TYPE REF TO /AWS1/CL_FNTCUSTOMORIGINCONFIG /AWS1/CL_FNTCUSTOMORIGINCONFIG

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.

io_vpcoriginconfig TYPE REF TO /AWS1/CL_FNTVPCORIGINCONFIG /AWS1/CL_FNTVPCORIGINCONFIG

The VPC origin configuration.

iv_connectionattempts TYPE /AWS1/FNTINTEGER /AWS1/FNTINTEGER

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.

iv_connectiontimeout TYPE /AWS1/FNTINTEGER /AWS1/FNTINTEGER

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.

iv_responsecompletiontimeout TYPE /AWS1/FNTINTEGER /AWS1/FNTINTEGER

The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection.

The value for ResponseCompletionTimeout must be equal to or greater than the value for OriginReadTimeout. If you don't set a value for ResponseCompletionTimeout, CloudFront doesn't enforce a maximum value.

For more information, see Response completion timeout in the Amazon CloudFront Developer Guide.

io_originshield TYPE REF TO /AWS1/CL_FNTORIGINSHIELD /AWS1/CL_FNTORIGINSHIELD

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.

iv_originaccesscontrolid TYPE /AWS1/FNTSTRING /AWS1/FNTSTRING

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.

---

Queryable Attributes

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.

Accessible with the following methods

Method	Description
GET_ID()	Getter for ID, with configurable default
ASK_ID()	Getter for ID w/ exceptions if field has no value
HAS_ID()	Determine if ID has a value

DomainName

The domain name for the origin.

For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.

Accessible with the following methods

Method	Description
GET_DOMAINNAME()	Getter for DOMAINNAME, with configurable default
ASK_DOMAINNAME()	Getter for DOMAINNAME w/ exceptions if field has no value
HAS_DOMAINNAME()	Determine if DOMAINNAME has a value

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.

Accessible with the following methods

Method	Description
GET_ORIGINPATH()	Getter for ORIGINPATH, with configurable default
ASK_ORIGINPATH()	Getter for ORIGINPATH w/ exceptions if field has no value
HAS_ORIGINPATH()	Determine if ORIGINPATH has a value

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.

Accessible with the following methods

Method	Description
GET_CUSTOMHEADERS()	Getter for CUSTOMHEADERS

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.

Accessible with the following methods

Method	Description
GET_S3ORIGINCONFIG()	Getter for S3ORIGINCONFIG

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.

Accessible with the following methods

Method	Description
GET_CUSTOMORIGINCONFIG()	Getter for CUSTOMORIGINCONFIG

VpcOriginConfig

The VPC origin configuration.

Accessible with the following methods

Method	Description
GET_VPCORIGINCONFIG()	Getter for VPCORIGINCONFIG

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.

Accessible with the following methods

Method	Description
GET_CONNECTIONATTEMPTS()	Getter for CONNECTIONATTEMPTS, with configurable default
ASK_CONNECTIONATTEMPTS()	Getter for CONNECTIONATTEMPTS w/ exceptions if field has no
HAS_CONNECTIONATTEMPTS()	Determine if CONNECTIONATTEMPTS has a value

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.

Accessible with the following methods

Method	Description
GET_CONNECTIONTIMEOUT()	Getter for CONNECTIONTIMEOUT, with configurable default
ASK_CONNECTIONTIMEOUT()	Getter for CONNECTIONTIMEOUT w/ exceptions if field has no v
HAS_CONNECTIONTIMEOUT()	Determine if CONNECTIONTIMEOUT has a value

ResponseCompletionTimeout

The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection.

The value for ResponseCompletionTimeout must be equal to or greater than the value for OriginReadTimeout. If you don't set a value for ResponseCompletionTimeout, CloudFront doesn't enforce a maximum value.

For more information, see Response completion timeout in the Amazon CloudFront Developer Guide.

Accessible with the following methods

Method	Description
GET_RSPCOMPLETIONTIMEOUT()	Getter for RESPONSECOMPLETIONTIMEOUT, with configurable defa
ASK_RSPCOMPLETIONTIMEOUT()	Getter for RESPONSECOMPLETIONTIMEOUT w/ exceptions if field
HAS_RSPCOMPLETIONTIMEOUT()	Determine if RESPONSECOMPLETIONTIMEOUT has a value

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.

Accessible with the following methods

Method	Description
GET_ORIGINSHIELD()	Getter for ORIGINSHIELD

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.

Accessible with the following methods

Method	Description
GET_ORIGINACCESSCONTROLID()	Getter for ORIGINACCESSCONTROLID, with configurable default
ASK_ORIGINACCESSCONTROLID()	Getter for ORIGINACCESSCONTROLID w/ exceptions if field has
HAS_ORIGINACCESSCONTROLID()	Determine if ORIGINACCESSCONTROLID has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_ORIGINLIST

TYPES TT_ORIGINLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_FNTORIGIN WITH DEFAULT KEY
.