Skip to content
v2.277.0

OriginBindOptions Struct ​

Options passed to Origin.bind().

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudfront as cloudfront } from 'aws-cdk-lib';
const originBindOptions: cloudfront.OriginBindOptions = {
  originId: 'originId',

  // the properties below are optional
  distributionId: 'distributionId',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cloudfront as cloudfront

origin_bind_options = cloudfront.OriginBindOptions(
    origin_id="originId",

    # the properties below are optional
    distribution_id="distributionId"
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudFront;

var originBindOptions = new OriginBindOptions {
    OriginId = "originId",

    // the properties below are optional
    DistributionId = "distributionId"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

originBindOptions := &OriginBindOptions{
	OriginId: jsii.String("originId"),

	// the properties below are optional
	DistributionId: jsii.String("distributionId"),
}

Properties ​

distributionIdoptionalstringdistribution_idoptionalstrdistributionIdoptionalStringDistributionIdoptionalstringDistributionIdoptional*string #
The identifier of the Distribution this Origin is used for.

Default: no distribution id

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

originIdstringorigin_idstroriginIdStringOriginIdstringOriginId*string required #
The identifier of this Origin, as assigned by the Distribution this Origin has been used added to.