software.amazon.awscdk.services.cloudfront

Interface OriginBindConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

OriginBindConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-11T17:58:48.823Z")
 @Stability(value=Stable)
public interface OriginBindConfig
extends software.amazon.jsii.JsiiSerializable

The struct returned from IOrigin.bind.

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.*;
 IOrigin origin;
 OriginBindConfig originBindConfig = OriginBindConfig.builder()
         .failoverConfig(OriginFailoverConfig.builder()
                 .failoverOrigin(origin)
                 // the properties below are optional
                 .statusCodes(List.of(123))
                 .build())
         .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)
                         .originKeepaliveTimeout(123)
                         .originReadTimeout(123)
                         .originSslProtocols(List.of("originSslProtocols"))
                         .build())
                 .originCustomHeaders(List.of(OriginCustomHeaderProperty.builder()
                         .headerName("headerName")
                         .headerValue("headerValue")
                         .build()))
                 .originPath("originPath")
                 .originShield(OriginShieldProperty.builder()
                         .enabled(false)
                         .originShieldRegion("originShieldRegion")
                         .build())
                 .s3OriginConfig(S3OriginConfigProperty.builder()
                         .originAccessIdentity("originAccessIdentity")
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OriginBindConfig.Builder A builder for OriginBindConfig
static class	OriginBindConfig.Jsii$Proxy An implementation for OriginBindConfig

Method Summary

Modifier and Type	Method and Description
static OriginBindConfig.Builder	builder()
default OriginFailoverConfig	getFailoverConfig() The failover configuration for this Origin.
default CfnDistribution.OriginProperty	getOriginProperty() The CloudFormation OriginProperty configuration for this Origin.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFailoverConfig

@Stability(value=Stable)
 @Nullable
default OriginFailoverConfig getFailoverConfig()

The failover configuration for this Origin.

Default: - nothing is returned

getOriginProperty

@Stability(value=Stable)
 @Nullable
default CfnDistribution.OriginProperty getOriginProperty()

The CloudFormation OriginProperty configuration for this Origin.

Default: - nothing is returned

builder

@Stability(value=Stable)
static OriginBindConfig.Builder builder()

Returns:

a OriginBindConfig.Builder of OriginBindConfig