Interface Origin.Builder

    • Method Detail

      • id

        Origin.Builder id​(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.
      • domainName

        Origin.Builder domainName​(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.
      • originPath

        Origin.Builder originPath​(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.
      • customHeaders

        Origin.Builder customHeaders​(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.
      • s3OriginConfig

        Origin.Builder s3OriginConfig​(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.
      • customOriginConfig

        Origin.Builder customOriginConfig​(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.
      • connectionAttempts

        Origin.Builder connectionAttempts​(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.
      • connectionTimeout

        Origin.Builder connectionTimeout​(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.
      • originShield

        Origin.Builder originShield​(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.
      • originAccessControlId

        Origin.Builder originAccessControlId​(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.