Package software.amazon.awscdk.services.cloudfront

Interface CfnDistribution.OriginProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDistribution.OriginProperty.Jsii$Proxy
Enclosing class:
CfnDistribution
@Stability(Stable) public static interface CfnDistribution.OriginProperty extends software.amazon.jsii.JsiiSerializable
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 AWS Elemental MediaPackage endpoint
  • An AWS 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).

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudfront.*;
 OriginProperty originProperty = OriginProperty.builder()
         .domainName("domainName")
         .id("id")
         // the properties below are optional
         .connectionAttempts(123)
         .connectionTimeout(123)
         .customOriginConfig(CustomOriginConfigProperty.builder()
                 .originProtocolPolicy("originProtocolPolicy")
                 // the properties below are optional
                 .httpPort(123)
                 .httpsPort(123)
                 .ipAddressType("ipAddressType")
                 .originKeepaliveTimeout(123)
                 .originReadTimeout(123)
                 .originSslProtocols(List.of("originSslProtocols"))
                 .build())
         .originAccessControlId("originAccessControlId")
         .originCustomHeaders(List.of(OriginCustomHeaderProperty.builder()
                 .headerName("headerName")
                 .headerValue("headerValue")
                 .build()))
         .originPath("originPath")
         .originShield(OriginShieldProperty.builder()
                 .enabled(false)
                 .originShieldRegion("originShieldRegion")
                 .build())
         .responseCompletionTimeout(123)
         .s3OriginConfig(S3OriginConfigProperty.builder()
                 .originAccessIdentity("originAccessIdentity")
                 .originReadTimeout(123)
                 .build())
         .vpcOriginConfig(VpcOriginConfigProperty.builder()
                 .vpcOriginId("vpcOriginId")
                 // the properties below are optional
                 .originKeepaliveTimeout(123)
                 .originReadTimeout(123)
                 .ownerAccountId("ownerAccountId")
                 .build())
         .build();

See Also: