Struct aws_sdk_cloudfront::types::builders::OriginBuilder

#[non_exhaustive]
pub struct OriginBuilder { /* private fields */ }

A builder for Origin.

Implementations

impl OriginBuilder

pub fn id(self, input: impl Into<String>) -> Self

A unique identifier for the origin. This value must be unique within the distribution.

Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior.

This field is required.

pub fn set_id(self, input: Option<String>) -> Self

A unique identifier for the origin. This value must be unique within the distribution.

Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior.

pub fn get_id(&self) -> &Option<String>

A unique identifier for the origin. This value must be unique within the distribution.

Use this value to specify the TargetOriginId in a CacheBehavior or DefaultCacheBehavior.

pub fn domain_name(self, input: impl Into<String>) -> Self

The domain name for the origin.

For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.

This field is required.

pub fn set_domain_name(self, input: Option<String>) -> Self

The domain name for the origin.

For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.

pub fn get_domain_name(&self) -> &Option<String>

The domain name for the origin.

For more information, see Origin Domain Name in the Amazon CloudFront Developer Guide.

pub fn origin_path(self, input: impl Into<String>) -> Self

An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.

For more information, see Origin Path in the Amazon CloudFront Developer Guide.

pub fn set_origin_path(self, input: Option<String>) -> Self

An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.

For more information, see Origin Path in the Amazon CloudFront Developer Guide.

pub fn get_origin_path(&self) -> &Option<String>

An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.

For more information, see Origin Path in the Amazon CloudFront Developer Guide.

pub fn custom_headers(self, input: CustomHeaders) -> Self

A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.

For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.

pub fn set_custom_headers(self, input: Option<CustomHeaders>) -> Self

A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.

For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.

pub fn get_custom_headers(&self) -> &Option<CustomHeaders>

A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin.

For more information, see Adding Custom Headers to Origin Requests in the Amazon CloudFront Developer Guide.

pub fn s3_origin_config(self, input: S3OriginConfig) -> Self

Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.

pub fn set_s3_origin_config(self, input: Option<S3OriginConfig>) -> Self

Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.

pub fn get_s3_origin_config(&self) -> &Option<S3OriginConfig>

Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the CustomOriginConfig type instead.

pub fn custom_origin_config(self, input: CustomOriginConfig) -> Self

Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.

pub fn set_custom_origin_config(self, input: Option<CustomOriginConfig>) -> Self

Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.

pub fn get_custom_origin_config(&self) -> &Option<CustomOriginConfig>

Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.

pub fn connection_attempts(self, input: i32) -> Self

The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3.

For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout.

For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.

pub fn set_connection_attempts(self, input: Option<i32>) -> Self

The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3.

For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout.

For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.

pub fn get_connection_attempts(&self) -> &Option<i32>

The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3.

For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout.

For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.

pub fn connection_timeout(self, input: i32) -> Self

The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds.

For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.

pub fn set_connection_timeout(self, input: Option<i32>) -> Self

The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds.

For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.

pub fn get_connection_timeout(&self) -> &Option<i32>

The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds.

For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.

pub fn origin_shield(self, input: OriginShield) -> Self

CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.

For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.

pub fn set_origin_shield(self, input: Option<OriginShield>) -> Self

CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.

For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.

pub fn get_origin_shield(&self) -> &Option<OriginShield>

CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin.

For more information, see Using Origin Shield in the Amazon CloudFront Developer Guide.

pub fn origin_access_control_id(self, input: impl Into<String>) -> Self

The unique identifier of an origin access control for this origin.

For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide.

pub fn set_origin_access_control_id(self, input: Option<String>) -> Self

The unique identifier of an origin access control for this origin.

For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide.

pub fn get_origin_access_control_id(&self) -> &Option<String>

The unique identifier of an origin access control for this origin.

For more information, see Restricting access to an Amazon S3 origin in the Amazon CloudFront Developer Guide.

pub fn build(self) -> Result<Origin, BuildError>

Consumes the builder and constructs a Origin. This method will fail if any of the following fields are not set:

• id
• domain_name

Trait Implementations

impl Clone for OriginBuilder

fn clone(&self) -> OriginBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OriginBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OriginBuilder

fn default() -> OriginBuilder

Returns the “default value” for a type.

impl PartialEq for OriginBuilder

fn eq(&self, other: &OriginBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OriginBuilder