Package software.amazon.awscdk.services.cloudfront

Interface OriginBindOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

OriginBindOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:05.572Z")
@Stability(Stable)
public interface OriginBindOptions
extends software.amazon.jsii.JsiiSerializable

Options passed to Origin.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.*;
 OriginBindOptions originBindOptions = OriginBindOptions.builder()
         .originId("originId")
         // the properties below are optional
         .distributionId("distributionId")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OriginBindOptions.Builder	builder()
default String	getDistributionId()	The identifier of the Distribution this Origin is used for.
String	getOriginId()	The identifier of this Origin, as assigned by the Distribution this Origin has been used added to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getOriginId

@Stability(Stable)
@NotNull
String getOriginId()

The identifier of this Origin, as assigned by the Distribution this Origin has been used added to.

getDistributionId

@Stability(Stable)
@Nullable
default String getDistributionId()

The identifier of the Distribution this Origin is used for.

This is used to grant origin access permissions to the distribution for origin access control.

Default: - no distribution id

builder

@Stability(Stable)
static OriginBindOptions.Builder builder()

Returns:

a OriginBindOptions.Builder of OriginBindOptions