All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnDistributionPropsMixin.CustomOriginConfigProperty.Jsii$Proxy

Enclosing class:: CfnDistributionPropsMixin

@Stability(Stable) public static interface CfnDistributionPropsMixin.CustomOriginConfigProperty extends software.amazon.jsii.JsiiSerializable

A custom origin.

A custom origin is any origin that is not an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is configured with static website hosting is a custom origin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.cloudfront.*;
 CustomOriginConfigProperty customOriginConfigProperty = CustomOriginConfigProperty.builder()
         .httpPort(123)
         .httpsPort(123)
         .ipAddressType("ipAddressType")
         .originKeepaliveTimeout(123)
         .originMtlsConfig(OriginMtlsConfigProperty.builder()
                 .clientCertificateArn("clientCertificateArn")
                 .build())
         .originProtocolPolicy("originProtocolPolicy")
         .originReadTimeout(123)
         .originSslProtocols(List.of("originSslProtocols"))
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnDistributionPropsMixin.CustomOriginConfigProperty.Builder

A builder for CfnDistributionPropsMixin.CustomOriginConfigProperty

static final class

CfnDistributionPropsMixin.CustomOriginConfigProperty.Jsii$Proxy

An implementation for CfnDistributionPropsMixin.CustomOriginConfigProperty
Method Summary

Modifier and Type

Method

Description

static CfnDistributionPropsMixin.CustomOriginConfigProperty.Builder

builder()

default Number

getHttpPort()

The HTTP port that CloudFront uses to connect to the origin.

default Number

getHttpsPort()

The HTTPS port that CloudFront uses to connect to the origin.

default String

getIpAddressType()

Specifies which IP protocol CloudFront uses when connecting to your origin.

default Number

getOriginKeepaliveTimeout()

Specifies how long, in seconds, CloudFront persists its connection to the origin.

default Object

getOriginMtlsConfig()

Configures mutual TLS authentication between CloudFront and your origin server.

default String

getOriginProtocolPolicy()

Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin.

default Number

getOriginReadTimeout()

Specifies how long, in seconds, CloudFront waits for a response from the origin.

default List<String>

getOriginSslProtocols()

Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getHttpPort
  
  @Stability(Stable) @Nullable default Number getHttpPort()
  
  The HTTP port that CloudFront uses to connect to the origin.
  Specify the HTTP port that the origin listens on.
  Default: - 80
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-httpport
- getHttpsPort
  
  @Stability(Stable) @Nullable default Number getHttpsPort()
  
  The HTTPS port that CloudFront uses to connect to the origin.
  Specify the HTTPS port that the origin listens on.
  Default: - 443
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-httpsport
- getIpAddressType
  
  @Stability(Stable) @Nullable default String getIpAddressType()
  
  Specifies which IP protocol CloudFront uses when connecting to your origin.
  If your origin uses both IPv4 and IPv6 protocols, you can choose dualstack to help optimize reliability.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-ipaddresstype
- getOriginKeepaliveTimeout
  
  @Stability(Stable) @Nullable default Number getOriginKeepaliveTimeout()
  
  Specifies how long, in seconds, CloudFront persists its connection to the origin.
  The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 5 seconds.
  For more information, see Keep-alive timeout (custom origins only) in the Amazon CloudFront Developer Guide .
  Default: - 5
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originkeepalivetimeout
- getOriginMtlsConfig
  
  @Stability(Stable) @Nullable default Object getOriginMtlsConfig()
  
  Configures mutual TLS authentication between CloudFront and your origin server.
  Returns union: either IResolvable or CfnDistributionPropsMixin.OriginMtlsConfigProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originmtlsconfig
- getOriginProtocolPolicy
  
  @Stability(Stable) @Nullable default String getOriginProtocolPolicy()
  Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are:.
  
  http-only – CloudFront always uses HTTP to connect to the origin.
  
  match-viewer – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront.
  
  https-only – CloudFront always uses HTTPS to connect to the origin.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originprotocolpolicy
- getOriginReadTimeout
  
  @Stability(Stable) @Nullable default Number getOriginReadTimeout()
  
  Specifies how long, in seconds, CloudFront waits for a response from the origin.
  This is also known as the origin response timeout . The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 30 seconds.
  For more information, see Response timeout in the Amazon CloudFront Developer Guide .
  Default: - 30
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originreadtimeout
- getOriginSslProtocols
  
  @Stability(Stable) @Nullable default List<String> getOriginSslProtocols()
  
  Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS.
  Valid values include SSLv3 , TLSv1 , TLSv1.1 , and TLSv1.2 .
  For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html#cfn-cloudfront-distribution-customoriginconfig-originsslprotocols
- builder
  
  @Stability(Stable) static CfnDistributionPropsMixin.CustomOriginConfigProperty.Builder builder()
  
  Returns:
  
  a CfnDistributionPropsMixin.CustomOriginConfigProperty.Builder of CfnDistributionPropsMixin.CustomOriginConfigProperty

Interface CfnDistributionPropsMixin.CustomOriginConfigProperty

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getHttpPort

getHttpsPort

getIpAddressType

getOriginKeepaliveTimeout

getOriginMtlsConfig

getOriginProtocolPolicy

getOriginReadTimeout

getOriginSslProtocols

builder